diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..b1248e1 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,30 @@ +name: CI +on: + - push +jobs: + tests: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: + - '3.8' + - '3.9' + - '3.10' + - '3.11' + - '3.12' + - '3.13' + steps: + - uses: actions/checkout@v4 + - run: pip install numpy pytest + - run: pytest + docs: + if: false + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - run: pip install -r requirements.txt + - run: sudo apt install pandoc + - run: jupyter nbconvert examples.ipynb --to rst + working-directory: ./vondrak/docs + - run: make html + working-directory: ./vondrak/docs diff --git a/.gitignore b/.gitignore index 6d054a5..32077d0 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,6 @@ build __pycache__ .cache .eggs + +# assuming virtual env name is .venv via `python -m venv .venv` +.venv diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 9eab313..0000000 --- a/.travis.yml +++ /dev/null @@ -1,4 +0,0 @@ -language: python -python: ['2.6','2.7','3.2','3.3','3.4', '3.5'] -install: pip install -q -e . -script: py.test diff --git a/LICENSE b/LICENSE index e5a6f26..ce97106 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2016 Tom Spalding and available under the MIT license: +Copyright (c) 2024 Tom Spalding and available under the MIT license: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: diff --git a/README.rst b/README.rst index f1dbf43..bebcba5 100644 --- a/README.rst +++ b/README.rst @@ -26,14 +26,14 @@ The only dependency is `numpy `_. Install ======= -To install the `Vondrak Python package `_ via `PyPI `_, simply ``pip3 install vondrak``. For Python 2, use ``pip``. All code is hosted at `github.com/digitalvapor/vondrak `_. +To install the `Vondrak Python package `_ via `PyPI `_, simply ``pip3 install vondrak``. For Python 2, use ``pip``. All code is hosted at `github.com/dreamalligator/vondrak `_. -Alternatively, clone the repo ``git clone https://github.com/digitalvapor/vondrak``, and install from source with ``python3 setup.py install``. +Alternatively, clone the repo ``git clone https://github.com/dreamalligator/vondrak``, and install from source with ``python3 setup.py install``. Documentation ============= -View the docs at `digitalvapor.github.io/vondrak `_, or generate with ``make html`` in the ``docs`` folder. +View the docs at `dreamalligator.github.io/vondrak `_, or generate with ``make html`` in the ``docs`` folder. Development ===== @@ -42,9 +42,9 @@ Setup a conda environment by simply running ``conda env create --file environmen Tests ===== -Tests use the `pyttest `_ framework. Simply run ``py.test``. +Tests use the `pyttest `_ framework. Simply run ``pytest``. License ======= -This work is licensed under a `Creative Commons Attribution-ShareAlike 4.0 International License `_. +MIT diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..7bc6e93 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,13 @@ +# required +numpy + +# tests +pytest + +# docs +sphinx +jupyterlab + +# vondrak dev mode +# https://setuptools.pypa.io/en/latest/userguide/development_mode.html +--editable . diff --git a/scripts/setup_dev b/scripts/setup_dev new file mode 100755 index 0000000..70b2eef --- /dev/null +++ b/scripts/setup_dev @@ -0,0 +1,21 @@ +#!/bin/bash + +# https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments + +# +# 1. install dev deps +# + +sudo apt install -y \ + pandoc \ + python3-venv + +# +# 2. create virtual env +# +# python -m venv .venv +# +# 3. activate virtual env +# +# source .venv/bin/activate +# diff --git a/setup.py b/setup.py index 3234b30..41fcee6 100644 --- a/setup.py +++ b/setup.py @@ -18,11 +18,11 @@ description=("A Python implementation of Vondrák's long term precession " "model and Fortran code."), long_description=long_description_readme, - url='https://github.com/digitalvapor/vondrak', - download_url='https://github.com/digitalvapor/vondrak/tarball/{0}' + url='https://github.com/dreamalligator/vondrak', + download_url='https://github.com/dreamalligator/vondrak/tarball/{0}' .format(__version__), author='Tom Spalding', - author_email='tom@antivapor.net', + author_email='tom@blackforestbotanics.com', keywords=['astronomy', 'precession', 'vondrak', 'space', 'proper motion'], license='MIT', packages=[ @@ -34,7 +34,7 @@ }, install_requires=['numpy'], classifiers=[ - 'Development Status :: 4 - Beta', + 'Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', 'Intended Audience :: Education', 'Intended Audience :: Science/Research', diff --git a/vondrak/__init__.py b/vondrak/__init__.py index c566fd1..2e283cd 100644 --- a/vondrak/__init__.py +++ b/vondrak/__init__.py @@ -2,7 +2,7 @@ from numpy import array, sin, cos, sqrt, append import math -__version__ = '1.0.0' +__version__ = '1.1.0' # 2Pi TAU = 6.283185307179586476925287e0 diff --git a/vondrak/docs/README.md b/vondrak/docs/README.md new file mode 100644 index 0000000..718ebe3 --- /dev/null +++ b/vondrak/docs/README.md @@ -0,0 +1,3 @@ +* `pip install -r requirements.txt` +* `jupyter nbconvert examples.ipynb --to rst` +* `make html` diff --git a/vondrak/docs/conf.py b/vondrak/docs/conf.py index 7fbcbd0..2ee8deb 100644 --- a/vondrak/docs/conf.py +++ b/vondrak/docs/conf.py @@ -50,7 +50,7 @@ # General information about the project. project = u'vondrak' -copyright = u'2014, Tom Spalding' +copyright = u'2024, Tom Spalding' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/vondrak/docs/index.rst b/vondrak/docs/index.rst index a8de4b0..3484d79 100644 --- a/vondrak/docs/index.rst +++ b/vondrak/docs/index.rst @@ -13,8 +13,8 @@ You can also visit: * Official `Python Package Index `_ entry -* GitHub `project page `_ -* GitHub `issue tracker `_ +* GitHub `project page `_ +* GitHub `issue tracker `_ Table of Contents ================= diff --git a/vondrak/docs/installation.rst b/vondrak/docs/installation.rst index d9ccdd1..2f9256e 100644 --- a/vondrak/docs/installation.rst +++ b/vondrak/docs/installation.rst @@ -5,10 +5,10 @@ There is only one dependency for Vondrak, `NumPy `_. You ``pip3 install vondrak`` -Alternatively, clone the repo ``git clone https://github.com/digitalvapor/vondrak``, and install from source with ``python3 setup.py install``. +Alternatively, clone the repo ``git clone https://github.com/dreamalligator/vondrak``, and install from source with ``python3 setup.py install``. If you have any problems with installation, or would like to suggest an improvement, simply create an issue on the project's Github page: - https://github.com/digitalvapor/vondrak + https://github.com/dreamalligator/vondrak Cheers! diff --git a/vondrak/docs/readme.md b/vondrak/docs/readme.md deleted file mode 100644 index 2834ead..0000000 --- a/vondrak/docs/readme.md +++ /dev/null @@ -1,2 +0,0 @@ -* `ipython nbconvert examples.ipynb --to rst` -* `make html`