[691826]: / docs / _build / doctrees / getting-started.doctree

Download this file

31 lines (31 with data), 5.5 kB

Äē°Ćdocutils.nodesĒĆdocumentĒďĒ)ĀĒ}Ē(Ć	rawsourceĒĆĒĆchildrenĒ]ĒhĆsectionĒďĒ)ĀĒ}Ē(hhh]Ē(hĆtitleĒďĒ)ĀĒ}Ē(hĆGetting startedĒh]ĒhĆTextĒďĒĆGetting startedĒÖĒĀĒ}Ē(hhĆparentĒhhhĆsourceĒNĆlineĒNubaĆ
attributesĒ}Ē(ĆidsĒ]ĒĆclassesĒ]ĒĆnamesĒ]ĒĆdupnamesĒ]ĒĆbackrefsĒ]ĒuĆtagnameĒhhhhhhĆK/projects/shart/digital_pathology/scripts/wsitools/docs/getting-started.rstĒhKubh
)ĀĒ}Ē(hhh]Ē(h)ĀĒ}Ē(hĆQuick StartĒh]ĒhĆQuick StartĒÖĒĀĒ}Ē(hh0hh.hhhNhNubah}Ē(h]Ēh!]Ēh#]Ēh%]Ēh']Ēuh)hhh+hhhh*hKubh
)ĀĒ}Ē(hhh]Ē(h)ĀĒ}Ē(hĆInstallationĒh]ĒhĆInstallationĒÖĒĀĒ}Ē(hhAhh?hhhNhNubah}Ē(h]Ēh!]Ēh#]Ēh%]Ēh']Ēuh)hhh<hhhh*hKubhĆ	paragraphĒďĒ)ĀĒ}Ē(hĆVgit clone https://github.com/smujiang/WSITools.git
cd WSITools
python setup.py installĒh]Ē(hĆ
git clone ĒÖĒĀĒ}Ē(hĆ
git clone ĒhhOhhhNhNubhĆ	referenceĒďĒ)ĀĒ}Ē(hĆ(https://github.com/smujiang/WSITools.gitĒh]ĒhĆ(https://github.com/smujiang/WSITools.gitĒÖĒĀĒ}Ē(hh\hhZubah}Ē(h]Ēh!]Ēh#]Ēh%]Ēh']ĒĆrefuriĒh\uh)hXhhOubhĆ$
cd WSITools
python setup.py installĒÖĒĀĒ}Ē(hĆ$
cd WSITools
python setup.py installĒhhOhhhNhNubeh}Ē(h]Ēh!]Ēh#]Ēh%]Ēh']Ēuh)hMhh*hKhh<hhubhN)ĀĒ}Ē(hX6Note that when you install our package, the dependencies can be automatically installed, but you may need to install
the dependent OpenSlide_ library.
If using `PyCharm` or `venv` on Windows:
1. Download the correct binary_ file for your system
2. Copy all files from `/bin` into your `venv/Scripts/` directoryĒh]Ē(hĆÉNote that when you install our package, the dependencies can be automatically installed, but you may need to install
the dependent ĒÖĒĀĒ}Ē(hĆÉNote that when you install our package, the dependencies can be automatically installed, but you may need to install
the dependent ĒhhthhhNhNubhY)ĀĒ}Ē(hĆ
OpenSlide_Ēh]ĒhĆ	OpenSlideĒÖĒĀĒ}Ē(hĆ	OpenSlideĒhh}ubah}Ē(h]Ēh!]Ēh#]Ēh%]Ēh']ĒĆnameĒhÖĆrefuriĒĆhttps://openslide.orgĒuh)hXhhtĆresolvedĒKubhĆ library.
If using ĒÖĒĀĒ}Ē(hĆ library.
If using ĒhhthhhNhNubhĆtitle_referenceĒďĒ)ĀĒ}Ē(hĆ	`PyCharm`Ēh]ĒhĆPyCharmĒÖĒĀĒ}Ē(hĆPyCharmĒhhóubah}Ē(h]Ēh!]Ēh#]Ēh%]Ēh']Ēuh)hēhhtubhĆ or ĒÖĒĀĒ}Ē(hĆ or ĒhhthhhNhNubhĖ)ĀĒ}Ē(hĆ`venv`Ēh]ĒhĆvenvĒÖĒĀĒ}Ē(hĆvenvĒhhęubah}Ē(h]Ēh!]Ēh#]Ēh%]Ēh']Ēuh)hēhhtubhĆ% on Windows:
1. Download the correct ĒÖĒĀĒ}Ē(hĆ% on Windows:
1. Download the correct ĒhhthhhNhNubhY)ĀĒ}Ē(hĆbinary_Ēh]ĒhĆbinaryĒÖĒĀĒ}Ē(hĆbinaryĒhhŅubah}Ē(h]Ēh!]Ēh#]Ēh%]Ēh']ĒĆnameĒh«hćĆ0https://openslide.org/download/#windows-binariesĒuh)hXhhthŹKubhĆ- file for your system
2. Copy all files from ĒÖĒĀĒ}Ē(hĆ- file for your system
2. Copy all files from ĒhhthhhNhNubhĖ)ĀĒ}Ē(hĆ`/bin`Ēh]ĒhĆ/binĒÖĒĀĒ}Ē(hĆ/binĒhh’ubah}Ē(h]Ēh!]Ēh#]Ēh%]Ēh']Ēuh)hēhhtubhĆ into your ĒÖĒĀĒ}Ē(hĆ into your ĒhhthhhNhNubhĖ)ĀĒ}Ē(hĆ`venv/Scripts/`Ēh]ĒhĆ
venv/Scripts/ĒÖĒĀĒ}Ē(hĆ
venv/Scripts/Ēhhťubah}Ē(h]Ēh!]Ēh#]Ēh%]Ēh']Ēuh)hēhhtubhĆ
 directoryĒÖĒĀĒ}Ē(hĆ
 directoryĒhhthhhNhNubeh}Ē(h]Ēh!]Ēh#]Ēh%]Ēh']Ēuh)hMhh*hKhh<hhubhĆtargetĒďĒ)ĀĒ}Ē(hĆ$.. _OpenSlide: https://openslide.orgĒh]Ēh}Ē(h]ĒĆ	openslideĒah!]Ēh#]ĒĆ	openslideĒah%]Ēh']Ēhćhéuh)jhKhh<hhhh*Ć
referencedĒKubj)ĀĒ}Ē(hĆ<.. _binary: https://openslide.org/download/#windows-binariesĒh]Ēh}Ē(h]ĒĆbinaryĒah!]Ēh#]ĒĆbinaryĒah%]Ēh']ĒhćhŌuh)jhKhh<hhhh*jKubeh}Ē(h]ĒĆinstallationĒah!]Ēh#]ĒĆinstallationĒah%]Ēh']Ēuh)h	hh+hhhh*hKubeh}Ē(h]ĒĆquick-startĒah!]Ēh#]ĒĆquick startĒah%]Ēh']Ēuh)h	hhhhhh*hKubeh}Ē(h]ĒĆgetting-startedĒah!]Ēh#]ĒĆgetting startedĒah%]Ēh']Ēuh)h	hhhhhh*hKubah}Ē(h]Ēh!]Ēh#]Ēh%]Ēh']ĒĆsourceĒh*uh)hĆcurrent_sourceĒNĆcurrent_lineĒNĆsettingsĒĆdocutils.frontendĒĆValuesĒďĒ)ĀĒ}Ē(hNĆ	generatorĒNĆ	datestampĒNĆsource_linkĒNĆ
source_urlĒNĆ
toc_backlinksĒĆentryĒĆfootnote_backlinksĒKĆ
sectnum_xformĒKĆstrip_commentsĒNĆstrip_elements_with_classesĒNĆ
strip_classesĒNĆreport_levelĒKĆ
halt_levelĒKĆexit_status_levelĒKĆdebugĒNĆwarning_streamĒNĆ	tracebackĒąĆinput_encodingĒĆ	utf-8-sigĒĆinput_encoding_error_handlerĒĆstrictĒĆoutput_encodingĒĆutf-8ĒĆoutput_encoding_error_handlerĒjYĆerror_encodingĒĆUTF-8ĒĆerror_encoding_error_handlerĒĆbackslashreplaceĒĆ
language_codeĒĆenĒĆrecord_dependenciesĒNĆconfigĒNĆ	id_prefixĒhĆauto_id_prefixĒĆidĒĆ
dump_settingsĒNĆdump_internalsĒNĆdump_transformsĒNĆdump_pseudo_xmlĒNĆexpose_internalsĒNĆstrict_visitorĒNĆ_disable_configĒNĆ_sourceĒh*Ć_destinationĒNĆ
_config_filesĒ]ĒĆpep_referencesĒNĆpep_base_urlĒĆ https://www.python.org/dev/peps/ĒĆpep_file_url_templateĒĆpep-%04dĒĆrfc_referencesĒNĆrfc_base_urlĒĆhttps://tools.ietf.org/html/ĒĆ	tab_widthĒKĆtrim_footnote_reference_spaceĒČĆfile_insertion_enabledĒąĆraw_enabledĒKĆsyntax_highlightĒĆlongĒĆsmart_quotesĒąĆsmartquotes_localesĒ]ĒĆcharacter_level_inline_markupĒČĆdoctitle_xformĒČĆ
docinfo_xformĒKĆsectsubtitle_xformĒČĆembed_stylesheetĒČĆcloak_email_addressesĒąĆenvĒNubĆreporterĒNĆindirect_targetsĒ]ĒĆsubstitution_defsĒ}ĒĆsubstitution_namesĒ}ĒĆrefnamesĒ}Ē(Ć	openslideĒ]Ēh}aĆbinaryĒ]ĒhŅauĆrefidsĒ}ĒĆnameidsĒ}Ē(j3j0j+j(j#j jjjjuĆ	nametypesĒ}Ē(j3Nj+Nj#Njąjąuh}Ē(j0hj(h+j h<jjjjuĆ
footnote_refsĒ}ĒĆ
citation_refsĒ}ĒĆ
autofootnotesĒ]ĒĆautofootnote_refsĒ]ĒĆsymbol_footnotesĒ]ĒĆsymbol_footnote_refsĒ]ĒĆ	footnotesĒ]ĒĆ	citationsĒ]ĒĆautofootnote_startĒKĆsymbol_footnote_startĒKĆid_startĒKĆparse_messagesĒ]ĒĆtransform_messagesĒ]ĒĆtransformerĒNĆ
decorationĒNhhub.