readme: updated installation instructions

docs: updated installation instructions
fix: changed git link for integration_tests of cloning model repo. Updated plotting in reporting

Author: pabloitu

README.md

@@ -38,19 +38,25 @@
 The core of `floatCSEP` is built around the `pyCSEP`
 package (https://github.com/sceccode/pycsep), which itself contains the core dependencies.
 
-The simplest way to install `floatCSEP`, is by creating a `conda`
-environment (https://conda.io - checkout Anaconda or Miniconda) and install `pyCSEP`
+## Stable Release
+
+The simplest way to install `floatCSEP` is by creating a `conda`
+environment (https://conda.io - checkout Anaconda or Miniforge) and install `floatCSEP`
 from `conda-forge`
 
 ```
-conda env create -n $NAME
+conda create -n $NAME -y
 conda activate $NAME
-conda install -c conda-forge pycsep
+conda install -c conda-forge floatcsep -y
 ```
 
+## Latest version
+
 Clone and install the floatCSEP source code using `pip`
 
 ```
+conda create -n $NAME -y
+conda activate $NAME
 git clone https://github.com/cseptesting/floatcsep
 cd floatcsep
 pip install .

docs/intro/installation.rst

@@ -18,7 +18,7 @@ To install **floatCSEP**, first a ``conda`` manager should be installed (https:/
 
     .. code-block:: console
 
-        $ conda env create -n csep_env
+        $ conda create -n csep_env
         $ conda activate csep_env
 
 Then, clone and install the floatCSEP source code using ``pip``
@@ -60,7 +60,7 @@ Having a ``conda`` manager installed (https://conda.io), type in a console:
 
     .. code-block:: console
 
-        $ conda env create -n csep_env
+        $ conda create -n csep_env
         $ conda activate csep_env
         $ conda install -c conda-forge floatcsep
 
@@ -95,7 +95,7 @@ It is recommended (not obligatory) to use a ``conda`` environment to make sure y
 
     .. code-block:: console
 
-        $ conda env create -n csep_dev
+        $ conda create -n csep_dev
         $ conda activate csep_dev
         $ git clone https://github.com/${your_fork}/floatcsep
         $ cd floatcsep

floatcsep/postprocess/plot_handler.py

@@ -88,9 +88,8 @@ def plot_forecasts(experiment: "Experiment") -> None:
 
     for model in experiment.models:
         for window in time_windows:
-            ax = model.get_forecast(window, experiment.region).plot(
-                plot_args=plot_forecast_config
-            )
+            forecast = model.get_forecast(window, region=experiment.region)
+            ax = forecast.plot(plot_args=plot_forecast_config)
 
             # If catalog option is passed, catalog is plotted on top of the forecast
             if plot_forecast_config.get("catalog"):

floatcsep/postprocess/reporting.py

@@ -59,8 +59,14 @@ def generate_report(experiment, timewindow=-1):
         report.add_figure(
             "Input catalog",
             [
-                experiment.registry.get_figure("main_catalog_map"),
-                experiment.registry.get_figure("main_catalog_time"),
+                os.path.relpath(
+                    experiment.registry.get_figure("main_catalog_map"),
+                    experiment.registry.run_dir,
+                ),
+                os.path.relpath(
+                    experiment.registry.get_figure("main_catalog_time"),
+                    experiment.registry.run_dir,
+                ),
             ],
             level=3,
             ncols=1,
@@ -78,7 +84,12 @@ def generate_report(experiment, timewindow=-1):
         fig_path = experiment.registry.get_figure(timestr, test)
         width = test.plot_args[0].get("figsize", [4])[0] * 96
         report.add_figure(
-            f"{test.name}", fig_path, level=3, caption=test.markdown, add_ext=True, width=width
+            f"{test.name}",
+            os.path.relpath(fig_path, experiment.registry.run_dir),
+            level=3,
+            caption=test.markdown,
+            add_ext=True,
+            width=width,
         )
         for model in experiment.models:
             try:

tests/integration/test_model_interface.py

@@ -238,9 +238,7 @@ def test_from_git(self, mock_build_tree, mock_create_environment):
         path_ = os.path.join(tempfile.tempdir, _dir)
         if os.path.exists(path_):
             shutil.rmtree(path_)
-        giturl = (
-            "https://git.gfz-potsdam.de/csep-group/" "rise_italy_experiment/models/template.git"
-        )
+        giturl = "https://github.com/pabloitu/" "template.git"
         model_a = self.init_model(name=name, model_path=path_, giturl=giturl)
         model_a.stage()
 

tutorials/case_a/best_model.dat

@@ -1,3 +1,3 @@
-# lon_min lon_max lat_min lat_max depth_min depth_max mag_min mag_max rate mask
+# lon_min lon_max lat_min lat_max depth_min depth_max mag_min mag_max rate
 0 1 0 1 0 70 6 7 5e-1 1
 1 2 0 1 0 70 6 7 5e-1 0.1