Merge pull request #16 from sschmidt23/main

Update License and structure to prepare for PyPI
LSSTDESC · Aug 29, 2022 · fb2b59c · fb2b59c
2 parents c2a3857 + 17d7835
commit fb2b59c
Show file tree

Hide file tree

Showing 37 changed files with 63 additions and 48 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,3 +1,4 @@
+
 name: Continuous Integration
 
 on:
@@ -34,9 +35,10 @@ jobs:
 
     - name: Run test script
       run: |
+        cd src/desc_bpz/data_files/
         export BPZDATAPATH=$PWD
-        cd tests
-        python ../scripts/bpz.py test1000.h5 -P test1000.pars
+        cd ../../../tests
+        python ../src/desc_bpz/scripts/bpz.py test1000.h5 -P test1000.pars
 
     - name: Run other tests
       run: |

diff --git a/README.md b/README.md
@@ -7,16 +7,17 @@ If you use this code, please cite [Benitez (2000)](https://ui.adsabs.harvard.edu
 In order to run, you should set the environment variable
 
 
-`BPZDATAPATH` to point to the directory housing the SED, FILTER, and AB files.
+`BPZDATAPATH` to point to the directory housing the SED, FILTER, and AB files.  Default SED and FILTER files are available in the
+`src/desc_bpz/data_files/FILTER` and `src/desc_bpz/data_files/SED` directories
 
 
-To run traditional command-line `BPZ` use the `bpz.py` file in `scripts`, e.g.:
+To run traditional command-line `BPZ` use the `bpz.py` file in `src/desc_bpz/scripts`, e.g.:
 
 
-`python scripts/bpz.py yourasciicatalog.cat -P yourparameterfile.pars`
+`python src/desc_bpz/scripts/bpz.py yourasciicatalog.cat -P yourparameterfile.pars`
 
 
-Dan Coe's STScI webpage listed above contains a nice BPZ user guide, for more detail on running the code, please check that website.
+Dan Coe's STScI webpage (listed above) contains a nice BPZ user guide, for more detail on running the code, please check that website.
 
 
 However, this package will mainly be used as a library for running "bpz_lite" in the DESC PZ RAIL Package, see:

diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,50 @@
+[project]
+name = "desc_bpz"
+description = "Python3 version of BPZ used in DESC"
+version = "0.2"
+readme = "README.md"
+requires-python = ">=3.5"
+license = { file = "LICENSE" }
+authors = [
+    {name = "Noel Benitez, Dan Coe, Will Hartley, Sam Schmidt, Joe Zuntz, LSST DESC PZWG", email = "[email protected]"}
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "License :: OSI Approved :: MIT License",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Natural Language :: English",
+    "Operating System :: OS Independent"
+]
+dependencies = [
+    "numpy",
+    "scipy",
+    "pandas>=1.1",
+    "h5py",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "pytest-runner",
+]
+
+[build-system]
+requires = ["setuptools", "wheel", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src", "tests"]
+
+[tool.setuptools.package-data]
+"*" = ["*.h5", "*.yaml", "*.columns", "*.pars"]
+"desc_bpz.data_files.SED" = ["*.sed", "*.list"]
+"desc_bpz.data_files.AB" = ["*.AB"]
+"desc_bpz.data_files.FILTER" = ["*.res"]
+"desc_bpz.scripts" = ["*.columns", "*.pars"]
diff --git a/setup.py b/setup.py
@@ -1,41 +1,3 @@
-from setuptools import setup, find_namespace_packages
+from setuptools import setup
 
-packages = find_namespace_packages()
-setup(
-    name="desc_bpz",
-    version="0.1",
-    author="Noel Benitez, Dan Coe, Will Hartley,"
-        "Sam Schmidt, LSST DESC PZWG",
-    author_email="[email protected]",
-    packages=packages,
-    package_data={
-        "": ["*.h5", "*.yaml", "*.sed", "*.res",
-             "*.AB", "*.columns", "*.pars"],
-        "tests": ["*.h5", "*.yaml"],
-        "SED": ["*.sed"],
-        "FILTER": ["*.res"],
-        "AB": ["*.AB"],
-        "scripts": ["*.columns, *.pars"]
-    },
-    include_package_data=True,
-    license="MIT License",
-    description="Python3 version of BPZ used in DESC",
-    url="https://github.com/LSSTDESC/DESC_BPZ",
-    long_description=open("README.md").read(),
-    classifiers=[
-        "Development Status :: 4 - Beta",
-        "License :: OSI Approved :: MIT License",
-        "Intended Audience :: Developers",
-        "Intended Audience :: Science/Research",
-        "Operating System :: OS Independent",
-        "Programming Language :: Python"
-        ],
-    install_requires=['numpy',
-                      'scipy',
-                      'pandas>=1.1',
-                      'h5py',
-                      ],
-    python_requires='>=3.5',
-    setup_requires=['pytest-runner'],
-    tests_require=['pytest'],
-)
+setup()
diff --git a/desc_bpz/MLab_coe_py3.py → src/desc_bpz/MLab_coe_py3.py b/desc_bpz/MLab_coe_py3.py → src/desc_bpz/MLab_coe_py3.py
diff --git a/desc_bpz/__init__.py → src/desc_bpz/__init__.py b/desc_bpz/__init__.py → src/desc_bpz/__init__.py
diff --git a/desc_bpz/bpz_tools_py3.py → src/desc_bpz/bpz_tools_py3.py b/desc_bpz/bpz_tools_py3.py → src/desc_bpz/bpz_tools_py3.py
diff --git a/desc_bpz/coeio_py3.py → src/desc_bpz/coeio_py3.py b/desc_bpz/coeio_py3.py → src/desc_bpz/coeio_py3.py
diff --git a/desc_bpz/coetools_py3.py → src/desc_bpz/coetools_py3.py b/desc_bpz/coetools_py3.py → src/desc_bpz/coetools_py3.py
diff --git a/desc_bpz/compress2_py3.py → src/desc_bpz/compress2_py3.py b/desc_bpz/compress2_py3.py → src/desc_bpz/compress2_py3.py
diff --git a/AB/El_B2004a.DC2LSST_g.AB → ..._bpz/data_files/AB/El_B2004a.DC2LSST_g.AB b/AB/El_B2004a.DC2LSST_g.AB → ..._bpz/data_files/AB/El_B2004a.DC2LSST_g.AB
diff --git a/FILTER/DC2LSST_g.res → src/desc_bpz/data_files/FILTER/DC2LSST_g.res b/FILTER/DC2LSST_g.res → src/desc_bpz/data_files/FILTER/DC2LSST_g.res
diff --git a/FILTER/DC2LSST_i.res → src/desc_bpz/data_files/FILTER/DC2LSST_i.res b/FILTER/DC2LSST_i.res → src/desc_bpz/data_files/FILTER/DC2LSST_i.res
diff --git a/FILTER/DC2LSST_r.res → src/desc_bpz/data_files/FILTER/DC2LSST_r.res b/FILTER/DC2LSST_r.res → src/desc_bpz/data_files/FILTER/DC2LSST_r.res
diff --git a/FILTER/DC2LSST_u.res → src/desc_bpz/data_files/FILTER/DC2LSST_u.res b/FILTER/DC2LSST_u.res → src/desc_bpz/data_files/FILTER/DC2LSST_u.res
diff --git a/FILTER/DC2LSST_y.res → src/desc_bpz/data_files/FILTER/DC2LSST_y.res b/FILTER/DC2LSST_y.res → src/desc_bpz/data_files/FILTER/DC2LSST_y.res
diff --git a/FILTER/DC2LSST_z.res → src/desc_bpz/data_files/FILTER/DC2LSST_z.res b/FILTER/DC2LSST_z.res → src/desc_bpz/data_files/FILTER/DC2LSST_z.res
diff --git a/SED/CWWSB4.list → src/desc_bpz/data_files/SED/CWWSB4.list b/SED/CWWSB4.list → src/desc_bpz/data_files/SED/CWWSB4.list
diff --git a/SED/El_B2004a.sed → src/desc_bpz/data_files/SED/El_B2004a.sed b/SED/El_B2004a.sed → src/desc_bpz/data_files/SED/El_B2004a.sed
diff --git a/SED/Im_B2004a.sed → src/desc_bpz/data_files/SED/Im_B2004a.sed b/SED/Im_B2004a.sed → src/desc_bpz/data_files/SED/Im_B2004a.sed
diff --git a/SED/SB2_B2004a.sed → src/desc_bpz/data_files/SED/SB2_B2004a.sed b/SED/SB2_B2004a.sed → src/desc_bpz/data_files/SED/SB2_B2004a.sed
diff --git a/SED/SB3_B2004a.sed → src/desc_bpz/data_files/SED/SB3_B2004a.sed b/SED/SB3_B2004a.sed → src/desc_bpz/data_files/SED/SB3_B2004a.sed
diff --git a/SED/Sbc_B2004a.sed → src/desc_bpz/data_files/SED/Sbc_B2004a.sed b/SED/Sbc_B2004a.sed → src/desc_bpz/data_files/SED/Sbc_B2004a.sed
diff --git a/SED/Scd_B2004a.sed → src/desc_bpz/data_files/SED/Scd_B2004a.sed b/SED/Scd_B2004a.sed → src/desc_bpz/data_files/SED/Scd_B2004a.sed
diff --git a/SED/ssp_25Myr_z008.sed → ...esc_bpz/data_files/SED/ssp_25Myr_z008.sed b/SED/ssp_25Myr_z008.sed → ...esc_bpz/data_files/SED/ssp_25Myr_z008.sed
diff --git a/SED/ssp_5Myr_z008.sed → ...desc_bpz/data_files/SED/ssp_5Myr_z008.sed b/SED/ssp_5Myr_z008.sed → ...desc_bpz/data_files/SED/ssp_5Myr_z008.sed
diff --git a/desc_bpz/func_py3.py → src/desc_bpz/func_py3.py b/desc_bpz/func_py3.py → src/desc_bpz/func_py3.py
diff --git a/desc_bpz/paths.py → src/desc_bpz/paths.py b/desc_bpz/paths.py → src/desc_bpz/paths.py
diff --git a/desc_bpz/prior_from_dict.py → src/desc_bpz/prior_from_dict.py b/desc_bpz/prior_from_dict.py → src/desc_bpz/prior_from_dict.py
diff --git a/desc_bpz/prior_hdfn_gen.py → src/desc_bpz/prior_hdfn_gen.py b/desc_bpz/prior_hdfn_gen.py → src/desc_bpz/prior_hdfn_gen.py
diff --git a/scripts/CSDC2114_test.columns → src/desc_bpz/scripts/CSDC2114_test.columns b/scripts/CSDC2114_test.columns → src/desc_bpz/scripts/CSDC2114_test.columns
diff --git a/scripts/bpz.py → src/desc_bpz/scripts/bpz.py b/scripts/bpz.py → src/desc_bpz/scripts/bpz.py
diff --git a/desc_bpz/spline_py3.py → src/desc_bpz/spline_py3.py b/desc_bpz/spline_py3.py → src/desc_bpz/spline_py3.py
diff --git a/desc_bpz/useful_py3.py → src/desc_bpz/useful_py3.py b/desc_bpz/useful_py3.py → src/desc_bpz/useful_py3.py
diff --git a/desc_bpz/version.py → src/desc_bpz/version.py b/desc_bpz/version.py → src/desc_bpz/version.py
@@ -1,2 +1,2 @@
 # just set version manually for now
-__version__ = "0.1"
+__version__ = "0.2"
diff --git a/desc_bpz/will_tools_py3.py → src/desc_bpz/will_tools_py3.py b/desc_bpz/will_tools_py3.py → src/desc_bpz/will_tools_py3.py
diff --git a/tests/test_paths.py b/tests/test_paths.py
@@ -1,7 +1,7 @@
 import os
 import pytest
 dirname, _ = os.path.split(__file__)
-parent = os.path.join(dirname, '..')
+parent = os.path.join(dirname, '../src/desc_bpz/data_files/')
 
 
 # This test has to go first