update environment files and references in contributing guidelines

NCAR · Feb 2, 2024 · a4c7797 · a4c7797
1 parent 489910e
commit a4c7797
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 21 deletions.
diff --git a/build_envs/platform-specific/README.md b/build_envs/platform-specific/README.md
@@ -0,0 +1,3 @@
+These platform specific environment files are included here for reference only and not actively tested or maintained.
+
+We have moved to a single environment file (../environment.yml) for all platforms.
diff --git a/build_envs/Linux.yml → build_envs/platform-specific/linux.yml b/build_envs/Linux.yml → build_envs/platform-specific/linux.yml
@@ -3,7 +3,7 @@ name: wrf_python_build
 channels:
   - conda-forge
 dependencies:
-  - python=3
+  - python<3.12
   - basemap
   - cartopy
   - gcc_linux-64

diff --git a/build_envs/platform-specific/macos_arm64.yml b/build_envs/platform-specific/macos_arm64.yml
@@ -0,0 +1,21 @@
+# Create full conda environment for development, including some useful tools
+name: wrf_python_build
+channels:
+  - conda-forge
+dependencies:
+  - python<3.12
+  - basemap
+  - cartopy
+  - clang_osx-arm64
+  - gfortran_osx-arm64
+  - jupyter
+  - matplotlib
+  - netcdf4
+  - numpy
+  - pycodestyle
+  - setuptools
+  - sphinx
+  - sphinx_rtd_theme
+  - wrapt
+  - xarray
+
diff --git a/build_envs/Darwin.yml → build_envs/platform-specific/macos_x64.yml b/build_envs/Darwin.yml → build_envs/platform-specific/macos_x64.yml
@@ -3,7 +3,7 @@ name: wrf_python_build
 channels:
   - conda-forge
 dependencies:
-  - python=3
+  - python<3.12
   - basemap
   - cartopy
   - clang_osx-64

diff --git a/build_envs/Win64.yml → build_envs/platform-specific/windows.yml b/build_envs/Win64.yml → build_envs/platform-specific/windows.yml
@@ -4,7 +4,7 @@ channels:
   - conda-forge
   - msys2
 dependencies:
-  - python=3
+  - python<3.12
   - basemap
   - cartopy
   - jupyter

diff --git a/doc/source/contrib.rst b/doc/source/contrib.rst
@@ -294,28 +294,13 @@ contributing is:
   
      git remote add ncar https://github.com/ncar/wrf-python.git
      
-- To create the development environment, you'll need to run the appropriate 
-  command below for your operating system.
-
-  OSX:
-
-  .. code::
-  
-     conda env create -f build_envs/Darwin.yml
-     
-  Linux:
-
-  .. code::
-  
-     conda env create -f build_envs/Linux.yml
-     
-  Win64:
+- To create the development environment, you'll need to run the command below:
 
   .. code::
   
-     conda env create -f build_envs/Win64.yml
+     conda env create -f build_envs/environment.yml
      
-  Note: For Win64, you will also need VS2015 installed on your system.
+  Note: For Windows, you will also need Visual Studio installed on your system.
 
 - Activate your conda environment.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		These platform specific environment files are included here for reference only and not actively tested or maintained.

		We have moved to a single environment file (../environment.yml) for all platforms.