From 322bc2de3f89ee23647d3aeb4e45d989247e1a66 Mon Sep 17 00:00:00 2001 From: Doug Latornell Date: Mon, 23 Dec 2024 12:09:31 -0800 Subject: [PATCH 1/3] Move SalishSeaTools environment.yaml to envs/ dir Updated paths in documentation and comments to reflect the file move. This reorganization improves structure by grouping environment-related files under the `envs` directory. --- SalishSeaTools/docs/development.rst | 2 +- SalishSeaTools/{ => envs}/environment.yaml | 4 ++-- SalishSeaTools/requirements.txt | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) rename SalishSeaTools/{ => envs}/environment.yaml (88%) diff --git a/SalishSeaTools/docs/development.rst b/SalishSeaTools/docs/development.rst index 786f347c..8505e88c 100644 --- a/SalishSeaTools/docs/development.rst +++ b/SalishSeaTools/docs/development.rst @@ -69,7 +69,7 @@ and building the documentation with the commands: .. code-block:: bash $ cd tools - $ conda env create -f SalishSeaTools/environment.yaml + $ conda env create -f SalishSeaTools/envs/environment.yaml $ conda activate salishsea-tools (salishsea-tools)$ pip install --editable SalishSeaTools diff --git a/SalishSeaTools/environment.yaml b/SalishSeaTools/envs/environment.yaml similarity index 88% rename from SalishSeaTools/environment.yaml rename to SalishSeaTools/envs/environment.yaml index ec2dbe26..579d8657 100644 --- a/SalishSeaTools/environment.yaml +++ b/SalishSeaTools/envs/environment.yaml @@ -5,11 +5,11 @@ # of the SalishSeaTools package with: # # $ cd tools -# $ conda env create -f SalishSeaTools/environment.yaml +# $ conda env create -f SalishSeaTools/envs/environment.yaml # $ conda activate salishsea-tools # (salishsea-tools)$ python -m pip install --editable SalishSeaTools # -# See the requirements.txt file for an exhaustive list of all of the +# See the requirements.txt file for an exhaustive list of all the # packages installed in the environment and their versions used in # recent development. diff --git a/SalishSeaTools/requirements.txt b/SalishSeaTools/requirements.txt index 1e1d83fa..05e22a35 100644 --- a/SalishSeaTools/requirements.txt +++ b/SalishSeaTools/requirements.txt @@ -1,7 +1,7 @@ # Python packages and version used in development environment # # This list is intended to be for reference only. -# Use the conda environment description file (environment.yaml) +# Use the conda environment description file (envs/environment.yaml) # to create an isolated development environment. # # Create/update this file with: From abb54645f8614155e4eaf900ecf6df4be2b8b0a0 Mon Sep 17 00:00:00 2001 From: Doug Latornell Date: Mon, 23 Dec 2024 12:13:21 -0800 Subject: [PATCH 2/3] Move SalishSeaTools requirements.txt to envs/ dir Moved requirements.txt to the 'envs/' directory for better organization and clarity. Updated the comment to reflect the new file path for maintaining dependencies. --- SalishSeaTools/envs/environment.yaml | 2 +- SalishSeaTools/{ => envs}/requirements.txt | 2 +- SalishSeaTools/setup.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) rename SalishSeaTools/{ => envs}/requirements.txt (99%) diff --git a/SalishSeaTools/envs/environment.yaml b/SalishSeaTools/envs/environment.yaml index 579d8657..34c1c9cc 100644 --- a/SalishSeaTools/envs/environment.yaml +++ b/SalishSeaTools/envs/environment.yaml @@ -9,7 +9,7 @@ # $ conda activate salishsea-tools # (salishsea-tools)$ python -m pip install --editable SalishSeaTools # -# See the requirements.txt file for an exhaustive list of all the +# See the envs/requirements.txt file for an exhaustive list of all the # packages installed in the environment and their versions used in # recent development. diff --git a/SalishSeaTools/requirements.txt b/SalishSeaTools/envs/requirements.txt similarity index 99% rename from SalishSeaTools/requirements.txt rename to SalishSeaTools/envs/requirements.txt index 05e22a35..925d4ec5 100644 --- a/SalishSeaTools/requirements.txt +++ b/SalishSeaTools/envs/requirements.txt @@ -5,7 +5,7 @@ # to create an isolated development environment. # # Create/update this file with: -# (salishsea-tools)$ python -m pip list --format=freeze >> SalishSeaTools/requirements.txt +# (salishsea-tools)$ python -m pip list --format=freeze >> SalishSeaTools/envs/requirements.txt alabaster==1.0.0 angles==2.0 diff --git a/SalishSeaTools/setup.py b/SalishSeaTools/setup.py index aa3d8a66..ed92853a 100644 --- a/SalishSeaTools/setup.py +++ b/SalishSeaTools/setup.py @@ -42,7 +42,7 @@ except IOError: long_description = '' install_requires = [ - # see requirements.txt for versions most recently used in development + # see envs/requirements.txt for versions most recently used in development 'angles', 'arrow>=1.0.0', 'bottleneck', From 68009895bed17a14b404ba3422aa1474723d1803 Mon Sep 17 00:00:00 2001 From: Doug Latornell Date: Mon, 23 Dec 2024 12:23:51 -0800 Subject: [PATCH 3/3] Rename environment.yaml to environment-dev.yaml This change updates the environment file name to better reflect its purpose as a development environment configuration. All references in documentation and related files have been updated accordingly for consistency. --- SalishSeaTools/docs/development.rst | 2 +- SalishSeaTools/envs/{environment.yaml => environment-dev.yaml} | 2 +- SalishSeaTools/envs/requirements.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) rename SalishSeaTools/envs/{environment.yaml => environment-dev.yaml} (93%) diff --git a/SalishSeaTools/docs/development.rst b/SalishSeaTools/docs/development.rst index 8505e88c..7df18b02 100644 --- a/SalishSeaTools/docs/development.rst +++ b/SalishSeaTools/docs/development.rst @@ -69,7 +69,7 @@ and building the documentation with the commands: .. code-block:: bash $ cd tools - $ conda env create -f SalishSeaTools/envs/environment.yaml + $ conda env create -f SalishSeaTools/envs/environment-dev.yaml $ conda activate salishsea-tools (salishsea-tools)$ pip install --editable SalishSeaTools diff --git a/SalishSeaTools/envs/environment.yaml b/SalishSeaTools/envs/environment-dev.yaml similarity index 93% rename from SalishSeaTools/envs/environment.yaml rename to SalishSeaTools/envs/environment-dev.yaml index 34c1c9cc..83bfbe22 100644 --- a/SalishSeaTools/envs/environment.yaml +++ b/SalishSeaTools/envs/environment-dev.yaml @@ -5,7 +5,7 @@ # of the SalishSeaTools package with: # # $ cd tools -# $ conda env create -f SalishSeaTools/envs/environment.yaml +# $ conda env create -f SalishSeaTools/envs/environment-dev.yaml # $ conda activate salishsea-tools # (salishsea-tools)$ python -m pip install --editable SalishSeaTools # diff --git a/SalishSeaTools/envs/requirements.txt b/SalishSeaTools/envs/requirements.txt index 925d4ec5..b4b55c2a 100644 --- a/SalishSeaTools/envs/requirements.txt +++ b/SalishSeaTools/envs/requirements.txt @@ -1,7 +1,7 @@ # Python packages and version used in development environment # # This list is intended to be for reference only. -# Use the conda environment description file (envs/environment.yaml) +# Use the conda environment description file (envs/environment-dev.yaml) # to create an isolated development environment. # # Create/update this file with: