https://github.com/laserkelvin/pygopher

A Python wrapper for te spectroscopy program PGopher
https://github.com/laserkelvin/pygopher

Last synced: 2 days ago
JSON representation

A Python wrapper for te spectroscopy program PGopher

• Host: GitHub
• URL: https://github.com/laserkelvin/pygopher
• Owner: laserkelvin
• License: mit
• Created: 2019-09-13T02:17:31.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-19T19:18:47.000Z (about 1 year ago)
• Last Synced: 2024-04-16T04:09:29.010Z (8 months ago)
• Language: Python
• Size: 21.5 KB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
#############

PyGopher

#############

A Python interface to the PGopher spectral simulation program.

*************

Installation

*************

PyGopher supports Python 3.8+. In a new environment and with the code cloned, you can simply run:

.. code-block:: bash

    pip install .

For development dependencies, run ``pip install -e './[dev]'``

*************

Usage

*************

Simplest way to get started is to do a zero-specification RNG simulation:

.. code-block:: python

    >>> from pygopher import PGopher

    >>> pgo = PGopher.from_rng()

    # returns the line list and partition function as dataframes

    >>> linelist, qpart = pgo.simulate()

More flexibility in the documentation will come later, but for the most part,

we keep the same abstraction as PGopher, and so ``Molecule``, ``Simulation``,

``Species`` objects can be freely configured as if using the GUI by passing

kwargs into ``PGopher.from_rng``:

.. code-block:: python

    >>> pgo = PGopher.from_rng(species_kwargs={...}, mixture_kwargs={...})