Skip to content

Commit

Permalink
corrected paths in the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fcollas committed Sep 24, 2024
1 parent 1450afd commit 5c1dd6d
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 16 deletions.
8 changes: 4 additions & 4 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,17 @@ Now, append wavy root directory to $PYTHONPATH, for instance add the following t

.. code-block:: bash
export PYTHONPATH=$PYTHONPATH:/home/patrikb/wavy
export PYTHONPATH=$PYTHONPATH:/path/to/your/wavy
.. note::

My user *patrikb* was used in this example. This will be the case in more examples and needs to be adjusted for other users.
/path/to/your/wavy/ should be replace with the full path of your wavy folder. It will be the case throughout all this documentation.

Create an .env file in your wavy directory and point to the location where you plan to store your custom config files, as well as your wavy directory. Your .env-file could look like:

.. code-block:: bash
WAVY_CONFIG=path/to/your/config/files
WAVY_CONFIG=/path/to/your/config/
WAVY_DIR=/path/to/your/wavy/
How to start your own project and how to manage the config files is explained in a separate tutorial.
2 changes: 1 addition & 1 deletion docs/tutorials_collocmod.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Collocation of satellite and wave model
>>> from wavy.satellite_module import satellite_class as sc
>>> from wavy.collocation_module import collocation_class as cc
>>> tmpdir = '/home/patrikb/wavy/tests/data/L3/s3a/'
>>> tmpdir = '/path/to/your/wavy/tests/data/L3/s3a/'
>>> sd = "2022-2-1 12"
>>> ed = "2022-2-1 12"
>>> name = 's3a'
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials_consolidate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ The consolidate_class enables the consolidation of multiple satellite_class or i
>>> # satellite consolidate
>>> sco1 = sc(sd="2022-2-1",ed ="2022-2-3",region="NordicSeas", nID="cmems_L3_NRT",
... name='s3a').populate(path='/home/patrikb/wavy/tests/data/L3/s3a')
... name='s3a').populate(path='/path/to/your/wavy/tests/data/L3/s3a')
>>> sco2 = sc(sd="2022-2-1",ed ="2022-2-3",region="NordicSeas", nID="cmems_L3_NRT",
... name='s3b').populate(path='/home/patrikb/wavy/tests/data/L3/s3b')
... name='s3b').populate(path='/path/to/your/wavy/tests/data/L3/s3b')
>>> cso = cs([sco1,sco2])
Expand Down
8 changes: 4 additions & 4 deletions docs/tutorials_sat_download.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,13 @@ This means that for product cmems_L3_NRT you can choose among 7 satellite missio
machine ftp.ceda.ac.uk login {USER} password {PASSWORD}
machine ftp-access.aviso.altimetry.fr login {USER} password {PASSWORD}
Now, prepare your **wavy** environment with providing the directories for satellite data and model data. Add your path for satellite data here demonstrated for CMEMS with my user:
Now, prepare your **wavy** environment with providing the directories for satellite data and model data. Add your path for satellite data here demonstrated for CMEMS, indicating the path of your choice where you want your data to be stored:

.. code-block:: yaml
cmems_L3_NRT:
dst:
path_template: /home/patrikb/tmp_altimeter/L3/mission
path_template: /chosen/path/to/satellite/data/L3/mission
There exists also something called strsub which defines strings that are o substituted. In this case some are predefined as:
Expand All @@ -79,7 +79,7 @@ There exists also something called strsub which defines strings that are o subst
strsub: ['varalias','mission','region']
The str "mission" in your path_template will be replaced by the satellite mission that you download. So for Sentinel-3a the final path for your downloaded files will be automatically /home/patrikb/tmp_altimeter/L3/s3a with subfolders on year and month.
The str "mission" in your path_template will be replaced by the satellite mission that you download. So for Sentinel-3a the final path for your downloaded files will be automatically /chosen/path/to/satellite/data/L3/s3a with subfolders on year and month.

You can proceed now and download CMEMS NRT L3 data using the wavyDownload.py script:

Expand Down Expand Up @@ -119,7 +119,7 @@ You can also download altimeter data directly from python with the following lin
>>> # Initialize sc object
>>> sco = sc(sd=sd,ed=ed,nID=nID,name=name)
>>> # Download the data to a chosen directory
>>> path = '/home/patrikb/tmp_altimeter/L3/s3a'
>>> path = '/chosen/path/to/satellite/data/L3/s3a'
>>> sco.download(nproc=4, path=path)
2 changes: 1 addition & 1 deletion docs/tutorials_sat_filters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Basic, but very useful, filters can be applied to the altimtery time series usin
.. code-block:: python3
>>> from wavy.satellite_module import satellite_class as sc
>>> path = '/home/fabienc/Projects/patriks_fork_wavy/wavy/tests/data/L3/s3a'
>>> path = '/path/to/your/wavy/tests/data/L3/s3a'
>>> nID = 'cmems_L3_NRT'
>>> name = 's3a'
>>> region = 'NordicSeas'
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials_stormtrack.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Now start you python script:
>>> from wavy.utils import parse_date
>>> import pandas as pd
>>> f = pd.read_csv('/home/patrikb/wavy/tests/data/track/Katrina_track.csv')
>>> f = pd.read_csv('/path/to/your/wavy/tests/data/track/Katrina_track.csv')
>>> # convert dates to datetime
>>> dt = [parse_date(d) for d in f.date]
>>> lons = f.lon.values
Expand All @@ -78,7 +78,7 @@ Now start you python script:
... nID='CCIv1_L3', region='global',
... varalias = 'Hs', # default
... poi=pco)
>>> sco = sco.populate(path='/home/patrikb/wavy/tests/data/L3/multi/')
>>> sco = sco.populate(path='/path/to/your/wavy/tests/data/L3/multi/')
>>> # quicklook including track by passing poi
>>> sco.quicklook(m=True,poi=pco)
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials_triple_collocation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ First, let us import a serie of values we will consider as the true common signa
.. code-block:: python3
>>> import pandas as pd
>>> df = pd.read_csv('/home/patrikb/wavy/tests/data/triple_collocation/simulated_t.csv',
>>> df = pd.read_csv('/path/to/your/wavy/tests/data/triple_collocation/simulated_t.csv',
... header=None,
... names=['t'])
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials_wavyQuick.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Now, dump the satellite data to a netcdf-file for later use:

.. code-block:: bash
$ ./wavyQuick.py -sat s3a -reg mwam4 -sd 2020110100 -ed 2020110300 -dump /home/patrikb/tmp_altimeter/quickdump/test.nc
$ ./wavyQuick.py -sat s3a -reg mwam4 -sd 2020110100 -ed 2020110300 -dump /any/path/of/your/choice/test.nc
Browse for satellite data, collocate with wave model output and show footprints and model output for one time step and a given lead time (-lt 0) and time constraint (-twin 30):

Expand Down

0 comments on commit 5c1dd6d

Please sign in to comment.