Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove Cli #1444

Merged
merged 18 commits into from
Jul 17, 2019
3 changes: 0 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,6 @@ jobs:
- name: 3D smFISH data processing example
if: type = push and branch =~ /^(master|merge)/
script: make install-dev 3d_smFISH.py
- name: iss_cli.sh data processing example
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can plausibly remove the Makefile rules for running .sh data processing examples.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ping

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed!

if: type = push and branch =~ /^(master|merge)/
script: make install-dev iss_cli.sh
- name: iss_pipeline.py data processing example
if: type = push and branch =~ /^(master|merge)/
script: make TESTING=1 install-dev iss_pipeline.py
Expand Down
79 changes: 0 additions & 79 deletions docs/source/_static/data_processing_examples/iss_cli.sh

This file was deleted.

123 changes: 0 additions & 123 deletions docs/source/_static/tutorials/exec_running_a_pipeline.py

This file was deleted.

3 changes: 0 additions & 3 deletions docs/source/api/data_structures/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,3 @@ serialization for use in single-cell analysis environments such as Seurat_ and S

.. toctree::
intensity_table.rst

.. toctree::
pipeline_component.rst
7 changes: 0 additions & 7 deletions docs/source/api/data_structures/pipeline_component.rst

This file was deleted.

3 changes: 0 additions & 3 deletions docs/source/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@ API
.. toctree::
spots/index.rst

.. toctree::
recipe/index.rst

.. toctree::
types/index.rst

Expand Down
7 changes: 0 additions & 7 deletions docs/source/api/recipe/index.rst

This file was deleted.

14 changes: 0 additions & 14 deletions docs/source/creating_an_image_processing_pipeline/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,20 +75,6 @@ origin. At this point, it's trivial to create a cell x gene matrix.

tutorials/exec_feature_identification_and_annotation.rst

Putting Together a Pipeline Recipe and Running it
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we dropping the recipe runner?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took out all the recipe stuff :/ should leave the runner in?

-------------------------------------------------

Pipeline recipes should describe the computational steps to get from the input files to the output files. Pipeline
recipes should manage file input and output through the injected ``file_inputs`` and ``file_outputs`` variables. When a
recipe is executed, the user should provide a list of file paths or URLs, which are loaded as starfish objects (i.e.,
:ref:`ImageStack`, :ref:`Codebook`, :ref:`IntensityTable`, or :ref:`ExpressionMatrix`), and provided to the recipe in
the ``file_inputs`` array. Correspondingly, any results saved to the ``file_outputs`` array will be written to the
file paths users provide.

.. toctree::
:maxdepth: 1

tutorials/exec_running_a_pipeline.rst

Old Content not to be deleted yet.
----------------------------------
Expand Down
10 changes: 0 additions & 10 deletions docs/source/getting_started/example_workflow/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,3 @@ The above steps can be recapitulated using starfish as follows:

.. literalinclude:: ../../_static/data_processing_examples/iss_pipeline.py

Using the CLI
-------------

Starfish has a fully-featured CLI that mimics the API such that one does not need to write python
code to use starfish. Running the commands below will re-produce the notebook_ results using
starfish's CLI:

.. _notebook: ../../_static/data_processing_examples/iss_pipeline.py

.. literalinclude:: ../../_static/data_processing_examples/iss_cli.sh
3 changes: 1 addition & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ see the :ref:`Getting Started <getting started>` section.

Starfish's documentation also contains instructions on :ref:`creating image-based transcriptomics
processing pipelines <creating_an_image_processing_pipeline>`, tutorials on running
starfish using the CLI, API, and workflow runner, and a worked example of contributing code to
starfish using the API, and a worked example of contributing code to
starfish. Finally, advanced users can examine the :ref:`Data Structures <data structures>` and
:ref:`Help & Reference <help and reference>` sections to learn more details about _starfish_ and its
object models.
Expand Down Expand Up @@ -66,7 +66,6 @@ To see the code or report a bug, please visit the `github repository
* Spot-Finding: :ref:`API <detection>`
* Decoding: :ref:`API <decoding>`
* Segmenting: :ref:`API <segmentation>`
* Pipelining: :ref:`API <pipeline_component>`

.. raw:: html

Expand Down
35 changes: 0 additions & 35 deletions docs/source/usage/fov-builder/fov-builder.rst

This file was deleted.

26 changes: 6 additions & 20 deletions docs/source/usage/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -182,29 +182,15 @@ analysis with *starfish*. Background subtraction, for example, is
handled by Starfish. If there is confusion about what types of image
pre-processing should be applied, please open an issue.


Getting started with the CLI
----------------------------

The simplest way to get started with starfish for most users will be to try out the
command-line interface (CLI). After following the :ref:`installation <installation>`
instructions, a ``starfish`` command will be available. Running ``starfish --help``
will print out the subcommands that are available.

.. program-output:: env MPLBACKEND=Agg starfish --help

.. toctree::
:maxdepth: 3
:caption: CLI:

.. toctree::
fov-builder/fov-builder.rst

Configuration
--------------
.. toctree::
validation/index.rst
configuration/index.rst

Validation
-----------
.. toctree::
configuration/index.rst
validation/index.rst


Data Formatting Examples
Expand Down
Loading