Skip to content

Commit

Permalink
script divumentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Oftatkofta committed Oct 23, 2020
1 parent 0bde2d4 commit 8105323
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion docs/validation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,35 @@ All the validation figures can be re-generated on your local install by running
outpath = Path("path/to/output/folder")
validation.run_base_validation(inpath, outpath)
Alternatively the validation code can be run as a script found in /tests:

.. code-block::
>>python run_base_validation.py -i "path/to/S-BSST641/" -o "path/to/output/folder"
After some time you should have generated the 3 figures below in this chapter in your chosen output folder. To test the 5-sgigma analysis run the following code:

.. code-block:: python
from cellocity import validation
from pathlib import Path
inpath = Path("path/to/S-BSST641/")
outpath = Path("path/to/output/folder")
validation.run_5sigma_validation(inpath, outpath)
Alternatively the validation code can be run as a script found in /tests:

After some time you should have generated the 3 figures below in this chapter in your chosen output folder.
.. code-block::
>>python run_5sigma_validation.py -i "path/to/S-BSST641/" -o "path/to/output/folder"
First we'll start by looking at the base validation.

Process time
------------
Expand Down

0 comments on commit 8105323

Please sign in to comment.