add versioning in the same spirit as other packages - update web doc

README.md

@@ -81,39 +81,3 @@ To uninstall the pipeline: python pip_sn_pack.py --action uninstall --package=al
 
 ##
 
-<!-- 
-### Installing requested packages
-- pip install . --user --install-option="--package=metrics" --install-option="--branch=thebranch"
-
-### Running the Cadence metric
-- a notebook illustrating how to run the metric is available in the notebook directory (SNCadence.ipynb) of sn_pipe
-- Command line:
-  - python run_scripts/run_cadence_metric.py input/param_cadence_metric.yaml
-  - A description of the input yaml file is given [here](doc/yaml_cadence.md)
-  - you may have to change the 'filename' parameter to the OpSim db name you would like to use as input.
-- output : a set of plots: 
-- Mean cadence vs mean m5 (5-sigma depth) <img src="doc/cadence_m5_r.png" height="24">
-- Histogram of redshift limits <img src="doc/zlim_r.png" height="24">
-
-### Running the Signal-to-Noise Ratio (SNR) metric
-- a notebook illustrating how to run the metric is available in the notebook directory (SNSNR.ipynb) of sn_pipe
-- Command line:
-  -  python run_scripts/run_snr_metric.py input/param_snr_metric.yaml
-  - A description of the input yaml file is given [here](doc/yaml_snr.md)
-  - you may have to change the 'filename' parameter to the OpSim db name you would like to use as input.
- - output : a set of plots:
-   - SNR vs Time (per band and per season) <img src="doc/snr_z_season_1.png" height="24">
-
-## **Running the simulations**
-
-### Installing requested packages
-- pip install . --user --install-option="--package=simulation" --install-option="--branch=thebranch"
-
-### Light Curves simulation
-- a notebook illustrating how to run the simulation and vizualized outputs is available in the notebook directory (SNSimulation.ipynb) of sn_pipe
-- command line:
-  - python run_scripts/run_simulation.py input/param_simulation.yaml
-- output: two files, hdf5 format:
-  - Simu_*.hdf5: astropy table with the list of parameters used for simulation
-  - LC*.hdf5: list of (astropy tables) light curves. Each table is composed of metadata (simulation parameters) and of a table with LC points.  
--->

__init__.py

@@ -1 +1 @@
-__version__='v1.0.0'
+from .version import __version__

docs/Gen/sn_pipe.md

@@ -1,7 +1,8 @@
 # sn_pipe 
 
-.
+ * docs: sn_pipe doc
  * [for_batch](for_batch.md): set of scripts and input file to run the pipeline in batch mode
+ * \_\_init.py\_\_
  * input: set of input files
  * LICENCE: licence file
  * notebooks: set of notebooks to run the pipeline
@@ -16,3 +17,4 @@
  * setup_release.sh: setup file to setup lsst_sims release ([usage](usage_setup_release.md))
  * README.md: README file
  * docs: sn_pipe doc
+ * version.py: package version

docs/Gen/sn_pipe_fulltree.md

@@ -102,6 +102,7 @@
 |   |-- templates
 |       |-- Fake_cadence_template.yaml
 |       |-- param_fakesimulation_template.yaml
+|-- \_\_init.py\_\_
 |-- LICENCE
 |-- notebooks
 |   |-- SNCadence.ipynb
@@ -189,5 +190,5 @@
 |       |-- run_visu_cadence.py
 |-- setup.py
 |-- setup_release.sh
-
+|-- version.py
 ```

setup.py

@@ -64,7 +64,7 @@ def run(self):
 
 setup(
     name='sn_pipe',
-    version=__version__,
+    version='v1.0.0',
     description='A framework to run the Survey Strategy Support pipeline for supernovae',
     url='http://github.com/lsstdesc/sn_pipe',
     author='Philippe Gris',

version.py

@@ -0,0 +1 @@
+__version__='v1.0.0'