Skip to content

Commit

Permalink
Merge pull request #60 from emolter/release-errors
Browse files Browse the repository at this point in the history
resolves #59
  • Loading branch information
emolter authored Feb 19, 2024
2 parents 78afa5b + 6383994 commit 753d82f
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 15 deletions.
14 changes: 8 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,21 @@ data processing and modeling tools for ring, moon, and planet observations
Installation
------------

``pip install python`` (Python 3.9 to 3.12)
``pip install pylanetary`` (Python 3.9 to 3.12)

Features
--------
* Navigation and re-projection for solar system imaging observations (makes use of Cartopy); `Tutorial <https://pylanetary.readthedocs.io/en/latest/nav-tutorial.html>`_ and `example workflow <https://pylanetary.readthedocs.io/en/latest/nav-examples.html>`_.
* Navigation and re-projection for solar system imaging observations (makes use of Cartopy); `Nav Tutorial <https://pylanetary.readthedocs.io/en/latest/nav-tutorial.html>`_ and `example workflow <https://pylanetary.readthedocs.io/en/latest/nav-examples.html>`_.

* Read/write navigated solar system images and backplanes in the NAV multi-extension fits format, originally developed for the HST OPAL program
* Read/write navigated solar system images and backplanes in the NAV multi-extension fits format, originally developed for the HST OPAL program.

* Utilities for solar-system-specific unit conversions like I/F; `Tutorial <https://pylanetary.readthedocs.io/en/latest/utils-tutorial.html#I/F-calculation>`_.
* Easy access to solar system body static data (radius, mass, etc.) and ephemerides; `Body Tutorial <https://pylanetary.readthedocs.io/en/latest/tutorials/body-tutorial.html>`_.

* Ring-moon system modeling and model-data comparison; `Tutorial <https://pylanetary.readthedocs.io/en/latest/rings-tutorial.html>`_.
* Utilities for solar-system-specific unit conversions like I/F; `Units Tutorial <https://pylanetary.readthedocs.io/en/latest/tutorials/unit-conversions.html>`_.

* (coming soon) Compute Doppler winds from image cubes and compare with simulation output (e.g. EPIC)
* Ring-moon system modeling and model-data comparison; `Rings Tutorial <https://pylanetary.readthedocs.io/en/latest/rings-tutorial.html>`_.

* (coming soon) Compute Doppler winds from image cubes and compare with simulation output (e.g. EPIC).

Usage
-----
Expand Down
12 changes: 6 additions & 6 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
Installation
************

* download the requirements.txt file using the "download raw" option
Simple pip install should work, but we recommend to do so in a clean conda environment, as follows:

* ``conda create -n pylanetary-tester python=3.11`` (or any Python from 3.9 to 3.12)
* ``conda activate pylanetary-tester``
* ``pip install -r requirements.txt`` in same directory as requirements.txt
* ``pip install git+https://github.com/emolter/pylanetary.git@main``
* ``pip install pylanetary``

Pylanetary relies on as-yet-unreleased versions of the image\_registration and astroquery packages, and pypi does not support installation of unreleased packages. This is the reason that simply pip install pylanetary will not work right.

Troubleshooting
~~~~~~~~~~~~~~~
Here we attempt to document install issues people have had, and their solutions
Here we attempt to document install issues people have had, and their solutions.
Note that many of these issues pre-date the current version of pylanetary, and only arose due to the prior need
to download requirements.txt, which is no longer necessary for installation.

* requirements.txt not found. Most likely, you never downloaded requirements.txt, or you are not running pip install -r requirements.txt in the same folder where you put requirements.txt
* pip install requirements.txt fails instantly with a crazy-looking error message. Try opening requirements.txt, and check that its just ten or so lines of human-readable text. If it's some huge html soup, that means you didn't use the "download raw" button when downloading
Expand Down
5 changes: 2 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[project]
name = "pylanetary"

version = "0.0.5"
version = "0.1.0"
description = "data processing and modeling tools for ring, moon, and planet observations"
readme = "README.rst"
requires-python = ">=3.7"
requires-python = ">=3.9"
license = {file = "licenses/LICENSE.txt"}
keywords = ["astronomy", "astrophysics", "astropy", "solar system", "planetary", "planet"]
authors = [
Expand All @@ -14,7 +14,6 @@ maintainers = [
{name = "Ned Molter", email = "[email protected]" }
]


# For a list of valid classifiers, see https://pypi.org/classifiers/
classifiers = [
"Development Status :: 3 - Alpha",
Expand Down

0 comments on commit 753d82f

Please sign in to comment.