Metadata-Version: 2.4
Name: wneq
Version: 1.1.0
Summary: Package for nuclear equilibria
Author-email: "Bradley S. Meyer" <mbradle@g.clemson.edu>, Mengke Li <mengkel@g.clemson.edu>
Maintainer-email: "Bradley S. Meyer" <mbradle@g.clemson.edu>
License-Expression: GPL-3.0-or-later
Project-URL: Documentation, https://wneq.readthedocs.org
Project-URL: Repository, https://github.com/mbradle/wneq.git
Project-URL: Bug Tracker, https://github.com/mbradle/wneq/issues
Keywords: astronomy, nuclear astrophysics
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.0
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: wnnet
Requires-Dist: numpy
Dynamic: license-file

Overview
========

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.12509473.svg
  :target: https://zenodo.org/doi/10.5281/zenodo.12509473

wneq is a python package for computing nuclear equilibria.

|pypi| |doc_stat| |license| |test| |lint-test| |black|

Installation
------------

Install from `PyPI <https://pypi.org/project/wneq>`_ with pip by
typing in your favorite terminal::

    $ pip install wneq

Authors
-------

- Bradley S. Meyer <mbradle@g.clemson.edu>
- Mengke Li <mengkel@g.clemson.edu>


Contribute
----------

- Issue Tracker: `<https://github.com/mbradle/wneq/issues/>`_
- Source Code: `<https://github.com/mbradle/wneq/>`_

License
-------

The project is licensed under the GNU Public License v3 (or later).

Documentation
-------------

The project documentation is available at `<https://wneq.readthedocs.io>`_.

Usage
-----

The best way to get started using wneq is to follow the
`tutorial <https://github.com/mbradle/wneq/tree/main/tutorial>`_.

.. |pypi| image:: https://badge.fury.io/py/wneq.svg 
    :target: https://badge.fury.io/py/wneq
.. |license| image:: https://img.shields.io/github/license/mbradle/wneq
    :alt: GitHub
.. |doc_stat| image:: https://readthedocs.org/projects/wneq/badge/?version=latest
    :target: https://wneq.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
.. |test| image:: https://github.com/mbradle/wneq/actions/workflows/test.yml/badge.svg?branch=main&event=push
        :target: https://github.com/mbradle/wneq/actions/workflows/test.yml
.. |lint| image:: https://img.shields.io/badge/linting-pylint-yellowgreen
    :target: https://github.com/pylint-dev/pylint
.. |lint-test| image:: https://github.com/mbradle/wneq/actions/workflows/lint.yml/badge.svg?branch=main&event=push
        :target: https://github.com/mbradle/wneq/actions/workflows/lint.yml
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
