Skip to content

Commit

Permalink
initial documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
sophiamaedler committed May 30, 2024
1 parent 2131e57 commit 841cd55
Show file tree
Hide file tree
Showing 244 changed files with 25,048 additions and 1,360 deletions.
Binary file modified docs/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/doctrees/index.doctree
Binary file not shown.

Large diffs are not rendered by default.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/doctrees/pages/example_notebooks.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/module.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/module/ml.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/module/pipeline.doctree
Binary file not shown.
Binary file added docs/doctrees/pages/module/processing.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/doctrees/pages/notebooks/example_sparcspy_project.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/pipeline.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/pipeline/classification.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/pipeline/config.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/pipeline/extraction.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/pipeline/project.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/pipeline/segmentation.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/pipeline/selection.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/quickstart.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/quickstart/computational_workflow.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/quickstart/installation.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/sparcscmd.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/sparcscmd/sparcs_cleanup.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/sparcscmd/sparcs_split.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/sparcscmd/sparcs_stat.doctree
Binary file not shown.
Binary file added docs/html/_images/HDF5_data_containers 2.png
Binary file removed docs/html/_images/HDF5_data_containers.pdf
Binary file not shown.
Binary file removed docs/html/_images/WGA_segmentation_cytosol 2.pdf
Binary file not shown.
Binary file removed docs/html/_images/WGA_segmentation_cytosol.pdf
Binary file not shown.
Binary file removed docs/html/_images/WGA_segmentation_nucleus 2.pdf
Binary file not shown.
Binary file removed docs/html/_images/WGA_segmentation_nucleus.pdf
Binary file not shown.
Binary file removed docs/html/_images/class_hierarchy.pdf
Binary file not shown.
Binary file removed docs/html/_images/extraction_process.pdf
Binary file not shown.
Binary file removed docs/html/_images/graphical_abstract.pdf
Binary file not shown.
Binary file not shown.
Binary file added docs/html/_images/nucleus_mask_excerpt 2.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed docs/html/_images/project_structure 2.pdf
Binary file not shown.
Binary file removed docs/html/_images/project_structure.pdf
Binary file not shown.
Binary file added docs/html/_images/sparcspy_workflow_steps 2.png
Binary file removed docs/html/_images/sparcspy_workflow_steps.pdf
Binary file not shown.
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
SPARCSpy - image-based single cell analysis at scale in python
SPARCSpy - image-based single cell analysis at scale in Python
===============================================================

SPARCSpy is a scalable toolkit to analyse single-cell image datasets. This Python implementation efficiently segments individual cells, generates single-cell datasets and provides tools for the efficient deep learning classification of their phenotypes for downstream applications.
Expand Down
32 changes: 32 additions & 0 deletions docs/html/_sources/pages/example_notebooks.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
Example Notebooks
=====================

Basic SPARCSpy Project
----------------------

This notebook demonstrates the basic functionality of SPARCSpy. It shows you how to initialize a SPARCSpy project, load input images, segment, extract and classify the provided data and how to generate cutting instructions for excision on a leica LMD7 microscope.

.. toctree::
:maxdepth: 2

notebooks/example_sparcspy_project.ipynb

Timecourse SPARCSpy Project
---------------------------

This notebook demonstrates how to use SPARCSpy to analyze a timecourse experiment. It shows you how to initialize a SPARCSpy project, load input images, segment, extract and classify the provided data and how to generate cutting instructions for excision on a leica LMD7 microscope.

.. toctree::
:maxdepth: 2

notebooks/Example_Notebook_TimeCourse_Project.ipynb

Segmentation Workflows
----------------------

This notebook walks you through the currently implemented segmentation workflows.

.. toctree::
:maxdepth: 2

notebooks/example_notebook_segmentation_workflows.ipynb
59 changes: 59 additions & 0 deletions docs/html/_sources/pages/module/ml.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
*******************
ml
*******************

.. toctree::
:maxdepth: 3

datasets
########

.. automodule:: sparcscore.ml.datasets
:members:

metrics
########

.. automodule:: sparcscore.ml.metrics
:members:

models
########

.. autoclass:: sparcscore.ml.models.VGGBase
:members:
:show-inheritance: False

.. autoclass:: sparcscore.ml.models.VGG1
:members:
:show-inheritance:

.. autoclass:: sparcscore.ml.models.VGG2
:members:
:show-inheritance:


plmodels
########

.. autoclass:: sparcscore.ml.plmodels.MultilabelSupervisedModel
:members:
:show-inheritance: False

pretrained_models
#################

.. automodule:: sparcscore.ml.pretrained_models
:members:

transforms
###########

.. automodule:: sparcscore.ml.transforms
:members:

utils
###########

.. automodule:: sparcscore.ml.utils
:members:
18 changes: 18 additions & 0 deletions docs/html/_sources/pages/module/processing.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
*******************
processing
*******************

utils
######
.. automodule:: sparcscore.processing.utils
:members:

preprocessing
#############
.. automodule:: sparcscore.processing.preprocessing
:members:

segmentation
############
.. automodule:: sparcscore.processing.segmentation
:members:
Loading

0 comments on commit 841cd55

Please sign in to comment.