Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename the package to sorcha-addons #17

Merged
merged 4 commits into from
Oct 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .git_archival.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
node: $Format:%H$
node-date: $Format:%cI$
describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
ref-names: $Format:%D$
22 changes: 22 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# For explanation of this file and uses see
# https://git-scm.com/docs/gitattributes
# https://developer.lsst.io/git/git-lfs.html#using-git-lfs-enabled-repositories
#
# Used by https://github.com/lsst/afwdata.git
# *.boost filter=lfs diff=lfs merge=lfs -text
# *.dat filter=lfs diff=lfs merge=lfs -text
# *.fits filter=lfs diff=lfs merge=lfs -text
# *.gz filter=lfs diff=lfs merge=lfs -text
#
# apache parquet files
# *.parq filter=lfs diff=lfs merge=lfs -text
#
# sqlite files
# *.sqlite3 filter=lfs diff=lfs merge=lfs -text
#
# gzip files
# *.gz filter=lfs diff=lfs merge=lfs -text
#
# png image files
# *.png filter=lfs diff=lfs merge=lfs -text
.git_archival.txt export-subst
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Editor-created file backups
*~

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Sorcha Community Utilities
# Sorcha Add-ons


[![ci](https://github.com/dirac-institute/sorcha_community_utils/actions/workflows/smoke-test.yml/badge.svg)](https://github.com/dirac-institute/sorcha_community_utils/actions/workflows/smoke-test.yml)
[![pytest](https://github.com/dirac-institute/sorcha_community_utils/actions/workflows/testing-and-coverage.yml/badge.svg)](https://github.com/dirac-institute/sorcha_community_utils/actions/workflows/testing-and-coverage.yml)
[![Documentation Status](https://readthedocs.org/projects/sorcha-community-utils/badge/?version=latest)](https://sorcha-community-utils.readthedocs.io/en/latest/?badge=latest)
[![ci](https://github.com/dirac-institute/sorcha-addons/actions/workflows/smoke-test.yml/badge.svg)](https://github.com/dirac-institute/sorcha-addons/actions/workflows/smoke-test.yml)
[![pytest](https://github.com/dirac-institute/sorcha-addons/actions/workflows/testing-and-coverage.yml/badge.svg)](https://github.com/dirac-institute/sorcha-addons/actions/workflows/testing-and-coverage.yml)
[![Documentation Status](https://readthedocs.org/projects/sorcha-addons/badge/?version=latest)](https://sorcha-addons.readthedocs.io/en/latest/?badge=latest)

[![Template](https://img.shields.io/badge/Template-LINCC%20Frameworks%20Python%20Project%20Template-brightgreen)](https://lincc-ppt.readthedocs.io/en/latest/)

Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "sorcha_community_utils"
project = "sorcha_addons"
copyright = "2023, Meg Schwamb"
author = "Meg Schwamb"
release = version("sorcha_community_utils")
release = version("sorcha_addons")
# for example take major/minor
version = ".".join(release.split(".")[:2])

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"import numpy as np\n",
"import pandas as pd\n",
"import astropy.units as u\n",
"from sorcha_community_utils.activity.lsst_comet.model import Comet\n",
"from sorcha_addons.activity.lsst_comet.model import Comet\n",
"from sbpy.activity import Afrho\n",
"import synphot\n",
"\n",
Expand Down Expand Up @@ -99,7 +99,7 @@
"metadata": {},
"outputs": [],
"source": [
"from sorcha_community_utils.activity.lsst_comet.lsst_comet_activity import LSSTCometActivity\n",
"from sorcha_addons.activity.lsst_comet.lsst_comet_activity import LSSTCometActivity\n",
"from sorcha.activity.activity_registration import update_activity_subclasses\n",
"\n",
"update_activity_subclasses()\n",
Expand Down
4 changes: 2 additions & 2 deletions docs/notebooks/lightcurve/sinusoidal/sinusoidal_example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"outputs": [],
"source": [
"# Import the SinusoidalLightCurve class into the current scope\n",
"from sorcha_community_utils.lightcurve.sinusoidal.sinusoidal_lightcurve import SinusoidalLightCurve\n",
"from sorcha_addons.lightcurve.sinusoidal.sinusoidal_lightcurve import SinusoidalLightCurve\n",
"from sorcha.lightcurves.lightcurve_registration import update_lc_subclasses, LC_METHODS"
]
},
Expand Down Expand Up @@ -69,7 +69,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "sorcha_community_utils",
"display_name": "sorcha_addons",
"language": "python",
"name": "python3"
},
Expand Down
4 changes: 2 additions & 2 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ virtual environment.

.. code:: bash

>> pip install sorcha-community-utils
>> pip install sorcha-addons

Once the ``sorcha-community-utils`` is installed, Sorcha will automatically detect
Once the ``sorcha-addons`` is installed, Sorcha will automatically detect
the available plugins and make them available during processing.

To use one of the plugins from the community utilities, simply add the unique
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[project]
name = "sorcha_community_utils"
name = "sorcha_addons"
license = {file = "LICENSE"}
readme = "README.md"
authors = [
Expand Down Expand Up @@ -49,7 +49,7 @@ requires = [
build-backend = "setuptools.build_meta"

[tool.setuptools_scm]
write_to = "src/sorcha_community_utils/_version.py"
write_to = "src/sorcha_addons/_version.py"

[tool.pytest.ini_options]
testpaths = [
Expand Down
15 changes: 15 additions & 0 deletions src/sorcha_addons/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
from sorcha_addons import activity
from sorcha_addons import lightcurve

__all__ = [
"activity",
"lightcurve",
]

# Version information (autogenerated by setuptools-scm)
try:
from ._version import version as __version__
from ._version import version_tuple
except ImportError:
__version__ = "unknown version"
version_tuple = (0, 0, "unknown version")
7 changes: 0 additions & 7 deletions src/sorcha_community_utils/__init__.py

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from sorcha.modules.PPCalculateSimpleCometaryMagnitude import PPCalculateSimpleCometaryMagnitude

# imported so that it can be registered by `update_activity_subclasses`
from sorcha_community_utils.activity.lsst_comet.lsst_comet_activity import LSSTCometActivity
from sorcha_addons.activity.lsst_comet.lsst_comet_activity import LSSTCometActivity
from sorcha.activity.activity_registration import update_activity_subclasses


Expand Down
2 changes: 1 addition & 1 deletion tests/activity/lsst_comet/test_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import astropy.units as u
from sbpy.activity import Afrho
import synphot
from sorcha_community_utils.activity.lsst_comet.model import Comet
from sorcha_addons.activity.lsst_comet.model import Comet


class TestComet:
Expand Down
2 changes: 1 addition & 1 deletion tests/lightcurve/sinusoidal/test_sinusoidal.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from sorcha_community_utils.lightcurve.sinusoidal.sinusoidal_lightcurve import SinusoidalLightCurve
from sorcha_addons.lightcurve.sinusoidal.sinusoidal_lightcurve import SinusoidalLightCurve
import pandas as pd
import numpy as np

Expand Down