updated manual

README.rst

@@ -80,3 +80,7 @@ The package is jointly developed by the `Center for Coastal and Ocean Mapping, U
     :alt: joint efforts
 
 For further information, visit the `manual <https://www.hydroffice.org/manuals/ssm2/index.html>`_.
+
+.. note::
+   If you want to help improving SSM, this is the recommended
+   `starting point <https://www.hydroffice.org/manuals/ssm2/stable/developer_guide_how_to_contribute.html>`_.

docs/conf.py

@@ -57,7 +57,7 @@
 # The short X.Y version.
 version = '2024.2'
 # The full version, including alpha/beta/rc tags.
-release = '2024.2.0'
+release = '2024.2.1'
 
 numfig = True
 

docs/developer_guide_how_to_contribute.rst

@@ -8,7 +8,7 @@ Every open source project lives from the generous help by contributors that sacr
 Public Repositories
 ===================
 
-The source code is available on both `GitHub`_ and `BitBucket`_.
+The source code is available on `GitHub`_.
 
 To propose changes to Sound Speed Manager, you can follow the common Fork & Pull Request workflow.
 If you are not familiar with such a workflow, a good starting point may be this `short tutorial`_.
@@ -21,30 +21,56 @@ To make participation as pleasant as possible, this project adheres to the `Code
 
 Here are a few hints and rules to get you started:
 
-- Add yourself to the AUTHORS.txt_ file in an alphabetical fashion. Every contribution is valuable and shall be credited.
-- If your change is noteworthy, add an entry to the changelog_.
-- No contribution is too small; please submit as many fixes for typos and grammar bloopers as you can!
-- Don't *ever* break backward compatibility.
-- *Always* add tests and docs for your code. This is a hard rule; patches with missing tests or documentation won't be merged.
+* Add yourself to the AUTHORS.txt_ file in an alphabetical fashion. Every contribution is valuable and shall be credited.
+* If your change is noteworthy, add an entry to the changelog_.
+* No contribution is too small; please submit as many fixes for typos and grammar bloopers as you can!
+* Don't *ever* break backward compatibility.
+* *Always* add tests and docs for your code. This is a hard rule; patches with missing tests or documentation won't be merged.
   If a feature is not tested or documented, it does not exist.
-- Obey `PEP 8`_ and `PEP 257`_.
-- Write `good commit messages`_.
-- Ideally, `collapse`_ your commits, i.e. make your pull requests just one commit.
+* Obey `PEP 8`_ and `PEP 257`_.
+* Write `good commit messages`_.
+* Ideally, `collapse`_ your commits, i.e. make your pull requests just one commit.
 
 .. note::
-   If you have something great but aren't sure whether it adheres -- or even can adhere -- to the rules above: **please submit a pull request anyway**!
+   If you have something great but are not sure whether it adheres -- or even can adhere -- to the rules
+   above: **please submit a pull request anyway**!
    In the best case, we can mold it into something, in the worst case the pull request gets politely closed.
    There's absolutely nothing to fear.
 
 Thank you for considering to contribute! If you have any question or concerns, feel free to reach out to us.
 
+Development Quick-start
+=======================
+
+Clone and install (in development mode) the `GitHub` repo:
+
+* `git clone https://github.com/hydroffice/hyo2_soundspeed.git`
+* `pip install -e hyo2_soundspeed`
+
+The previous steps will also install all the required dependencies.
+
+If you have issues installing `hyo2.abc2`_, you may want to:
+
+* `git clone https://github.com/hydroffice/hyo2_abc2.git`
+* `pip install -e hyo2_abc2`
+
+For other issues installing dependencies (e.g., `GDAL`_), you may want to use `Anaconda`_.
+
+Good references for a working dev env are:
+
+* Windows: https://github.com/hydroffice/hyo2_soundspeed/raw/refs/heads/master/.github/workflows/ssm_on_windows.yml
+* Linux: https://github.com/hydroffice/hyo2_soundspeed/raw/refs/heads/master/.github/workflows/ssm_on_linux.yml
+
+
 .. _`short tutorial`: https://gist.github.com/giumas/67abeffcbf49d00703a57cbafac8b118
-.. _`GitHub`: https://github.com/hydroffice/hyo_soundspeed
-.. _`BitBucket`: https://bitbucket.org/ccomjhc/hyo_soundspeed
+.. _`GitHub`: https://github.com/hydroffice/hyo2_soundspeed
 .. _`Code of Conduct`: http://www.python.org/psf/codeofconduct/
 .. _AUTHORS.txt: https://bitbucket.org/ccomjhc/hyo_soundspeed/raw/master/AUTHORS.rst
 .. _changelog: https://bitbucket.org/ccomjhc/hyo_soundspeed/raw/master/HISTORY.rst
 .. _`PEP 8`: http://www.python.org/dev/peps/pep-0008/
 .. _`PEP 257`: http://www.python.org/dev/peps/pep-0257/
 .. _collapse: https://www.mercurial-scm.org/wiki/RebaseExtension
 .. _`good commit messages`: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+.. _`hyo2.abc2`: https://github.com/hydroffice/hyo2_abc2
+.. _`GDAL`: https://github.com/OSGeo/gdal
+.. _`Anaconda`: https://docs.anaconda.com/anaconda/install/

docs/developer_guide_todolist.rst

@@ -18,10 +18,7 @@ Manager
 Atlases
 ^^^^^^^
 
-* Add World Ocean Database 2013 (same data as WOA BUT preserved record of input data)
-* Add `World Ocean Atlas 2018 <https://www.nodc.noaa.gov/OC5/woa18/woa18-preliminary-notes.html>`_
 * Add HYCOM (near real time global prediction system)
-* Add more NOAA OFS models
 
 
 Research

docs/user_manual_installation.rst

@@ -32,7 +32,8 @@ Installation as stand-alone Python package
 
 If you decide to install the package in a Python environment, the dependencies are:
 
-* `basemap <https://github.com/matplotlib/basemap>`_
+* `appdirs <https://github.com/ActiveState/appdirs>`_
+* `cartopy <https://github.com/SciTools/cartopy>`_
 * `gdal <https://github.com/OSGeo/gdal>`_
 * `gsw <https://github.com/TEOS-10/python-gsw>`_ *(version == 3.0.6)*
 * `matplotlib <https://github.com/matplotlib/matplotlib>`_
@@ -43,10 +44,12 @@ If you decide to install the package in a Python environment, the dependencies a
 * `pyproj <https://github.com/jswhit/pyproj>`_
 * `pyserial <https://github.com/pyserial/pyserial>`_
 * `PySide6 <https://github.com/qtproject/pyside-pyside-setup>`_ *(only for the application)*
+* `qt-material <https://github.com/UN-GCPDS/qt-material>`_ *(only for the application)*
+* `requests <https://github.com/psf/requests>`_
 
 If you want to install the last stable version (from PyPI):
 
-* `pip install hyo2.soundspeed`
+* `pip install hyo2.ssm2`
 
 Or, if you prefer the bleeding edge code:
 

hyo2/ssm2/__init__.py

@@ -12,7 +12,7 @@
 logger.addHandler(logging.NullHandler())
 
 name = "Sound Speed"
-__version__ = '2024.2.0'
+__version__ = '2024.2.1'
 __copyright__ = 'Copyright 2024 University of New Hampshire, Center for Coastal and Ocean Mapping'
 
 pkg_info = PkgInfo(