Merge pull request #9 from NCAR/djgagne

Minimal setup.py and fixes to setup.cfg

.github/workflows/python-package-conda.yml

@@ -7,11 +7,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 5
-
+    defaults:
+      run:
+        shell: bash -l {0}
     steps:
     - uses: actions/checkout@v2
     - uses: conda-incubator/setup-miniconda@v2
       with:
+        miniconda-version: "latest"
         mamba-version: "*"
         channel-priority: true
         environment-file: environment.yml
@@ -36,4 +39,4 @@ jobs:
       shell: bash -l {0}
       run: |
         mamba install pytest
-        pytest echo/tests/tests.py
+        pytest

README.md

@@ -1,11 +1,20 @@
 # **E**arth **C**omputing **H**yperparameter **O**ptimization (ECHO): A distributed hyperparameter optimization package build with Optuna
 
 ### Install
+
+To install a stable version of ECHO from PyPI, use the following command:
+```bash
+pip install echo-opt
+```
+
+Install the latest version of ECHO directly from github with the following command:
 ```bash
 pip install git+https://github.com/NCAR/echo-opt.git
 ```
+
+
 Several commands will be placed onto the PATH:
-echo-opt, echo-report, echo-run
+`echo-opt, echo-report, echo-run`
 
 ### Usage
 Launch a new optimization study:

echo/VERSION

@@ -1 +1 @@
-1.0
+1.0.1

environment.yml

@@ -3,12 +3,12 @@ channels:
  - conda-forge
  - pytorch
 dependencies:
-  - python=3.8
+  - python=3.10
   - sphinx
   - pytest
   - setuptools
   - optuna
-  - numpy
+  - numpy<1.23.0
   - scipy
   - matplotlib
   - scikit-learn

setup.cfg

@@ -3,8 +3,8 @@ name = echo-opt
 description = Earth Computer Hyperparameter Optimization: Distributed hyperparameter optimization on HPC and GPU systems with analysis tools.
 long_description = file: README.md
 long_description_content_type = text/markdown
-author = John Schreck
-author_email = schreck@ucar.edu
+author = John Schreck, David John Gagne, Charlie Becker, Gabrielle Gantos
+author_email = miles@ucar.edu
 license = MIT
 license_file = LICENSE
 platform = any
@@ -19,14 +19,14 @@ url = https://github.com/NCAR/echo-opt
 
 [options]
 zip_safe=True
-packages=
+packages =
     echo
     echo.src
 include_package_data = True
 setup_requires = setuptools
 python_requires = >=3.7
 install_requires =
-    numpy
+    numpy<1.24.0
     scipy
     matplotlib
     optuna
@@ -40,14 +40,6 @@ install_requires =
     pyarrow
     pyyaml
 
-[options.packages.find]
-where = 
-    echo
-    echo/src
-exclude =
-    examples*
-    tests*
-
 [options.entry_points]
 console_scripts =
     echo-opt = echo.optimize:main

setup.py

@@ -1,11 +1,4 @@
 from setuptools import setup
 
-setup(
-  name="echo-opt",
-  version="1.0",
-  description="Earth Computer Hyperparameter Optimization",
-  author="John Schreck, David John Gagne, Charlie Becker, Gabrielle Gantos",
-  license="MIT",
-  url="https://github.com/NCAR/echo-opt",
-  packages=["echo", "echo/src"]
-)
+if __name__ == "__main__":
+    setup()