Metadata-Version: 2.1
Name: RePrimAnd
Version: 1.5b0
Summary: Library for handling equations of state for supranuclear matter, computing neutron star properties, and utilities for numerical relativity
Author-email: Wolfgang Kastaun <physik@fangwolg.de>
License: Copyright Notice and License Terms for the RePrimAnd library
        This work was developed by Dr. Wolfgang Kastaun.
        
        This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
        
        
        Binary python packages ('Wheels') of the RePrimAnd library may 
        include shared libraries by third parties. For such libraries, 
        the specific terms listed below apply in addition.
        
        
        
        Copyright Notice and License Terms for
        HDF5 (Hierarchical Data Format 5) Software Library and Utilities
        -----------------------------------------------------------------------------
        HDF5 (Hierarchical Data Format 5) Software Library and Utilities
        Copyright 2006 by The HDF Group.
        NCSA HDF5 (Hierarchical Data Format 5) Software Library and Utilities
        Copyright 1998-2006 by The Board of Trustees of the University of Illinois.
        All rights reserved.
        Redistribution and use in source and binary forms, with or without modification, are permitted for any
        purpose (including commercial purposes) provided that the following conditions are met:
        1. Redistributions of source code must retain the above copyright notice, this list of conditions, and
        the following disclaimer.
        2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions,
        and the following disclaimer in the documentation and/or materials provided with the distribution.
        3. Neither the name of The HDF Group, the name of the University, nor the name of any Contributor
        may be used to endorse or promote products derived from this software without specific prior
        written permission from The HDF Group, the University, or the Contributor, respectively.
        DISCLAIMER:
        THIS SOFTWARE IS PROVIDED BY THE HDF GROUP AND THE CONTRIBUTORS "AS IS" WITH NO
        WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED. IN NO EVENT SHALL THE HDF GROUP OR
        THE CONTRIBUTORS BE LIABLE FOR ANY DAMAGES SUFFERED BY THE USERS ARISING OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        You are under no obligation whatsoever to provide any bug fixes, patches, or upgrades to the features,
        functionality or performance of the source code ("Enhancements") to anyone; however, if you choose
        to make your Enhancements available either publicly, or directly to The HDF Group, without imposing a
        separate written license agreement for such Enhancements, then you hereby grant the following
        license: a non-exclusive, royalty-free perpetual license to install, use, modify, prepare derivative works,
        incorporate into other computer software, distribute, and sublicense such enhancements or derivative
        works thereof, in binary and source code form.
        -----------------------------------------------------------------------------
        -----------------------------------------------------------------------------
        Limited portions of HDF5 were developed by Lawrence Berkeley National Laboratory (LBNL). LBNL's
        Copyright Notice and Licensing Terms can be found here: COPYING_LBNL_HDF5 file in this directory or
        at http://support.hdfgroup.org/ftp/HDF5/releases/COPYING_LBNL_HDF5.
        -----------------------------------------------------------------------------
        -----------------------------------------------------------------------------
        Contributors: National Center for Supercomputing Applications (NCSA) at the University of Illinois,
        Fortner Software, Unidata Program Center (netCDF), The Independent JPEG Group (JPEG), Jean-loup
        Gailly and Mark Adler (gzip), and Digital Equipment Corporation (DEC).
        -----------------------------------------------------------------------------
        Portions of HDF5 were developed with support from the Lawrence Berkeley National Laboratory (LBNL)
        and the United States Department of Energy under Prime Contract No. DE-AC02-05CH11231.
        -----------------------------------------------------------------------------
        Portions of HDF5 were developed with support from Lawrence Livermore National Laboratory and the
        United States Department of Energy under Prime Contract No. DE-AC52-07NA27344.
        -----------------------------------------------------------------------------
        Portions of HDF5 were developed with support from the University of California, Lawrence Livermore
        National Laboratory (UC LLNL). The following statement applies to those portions of the product and
        must be retained in any redistribution of source code, binaries, documentation, and/or accompanying
        materials:
        This work was partially produced at the University of California, Lawrence Livermore National
        Laboratory (UC LLNL) under contract no. W-7405-ENG-48 (Contract 48) between the U.S. Department
        of Energy (DOE) and The Regents of the University of California (University) for the operation of UC
        LLNL.
        DISCLAIMER:
        THIS WORK WAS PREPARED AS AN ACCOUNT OF WORK SPONSORED BY AN AGENCY OF THEUNITED
        STATES GOVERNMENT. NEITHER THE UNITED STATES GOVERNMENT NOR THE UNIVERSITY OF
        CALIFORNIA NOR ANY OF THEIR EMPLOYEES, MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR
        ASSUMES ANY LIABILITY OR RESPONSIBILITY FOR THE ACCURACY, COMPLETENESS, OR USEFULNESS OF
        ANY INFORMATION, APPARATUS, PRODUCT, OR PROCESS DISCLOSED, OR REPRESENTS THAT ITS USE
        WOULD NOT INFRINGE PRIVATELY- OWNED RIGHTS. REFERENCE HEREIN TO ANY SPECIFIC
        COMMERCIAL PRODUCTS, PROCESS, OR SERVICE BY TRADE NAME, TRADEMARK, MANUFACTURER, OR
        OTHERWISE, DOES NOT NECESSARILY CONSTITUTE OR IMPLY ITS ENDORSEMENT, RECOMMENDATION,
        OR FAVORING BY THE UNITED STATES GOVERNMENT OR THE UNIVERSITY OF CALIFORNIA. THE VIEWS
        AND OPINIONS OF AUTHORS EXPRESSED HEREIN DO NOT NECESSARILY STATE OR REFLECT THOSE OF
        THE UNITED STATES GOVERNMENT OR THE UNIVERSITY OF CALIFORNIA, AND SHALL NOT BE USED FOR
        ADVERTISING OR PRODUCT ENDORSEMENT PURPOSES.
        -----------------------------------------------------------------------------
        
Project-URL: homepage, https://github.com/wokast/RePrimAnd
Project-URL: documentation, https://wokast.github.io/RePrimAnd/index.html
Project-URL: repository, https://github.com
Requires-Python: <3.11,>=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# What is this?

The pyRePrimAnd package provides a Python interface
for the RePrimAnd C++ library which can be found 
[here](https://wokast.github.io/RePrimAnd/index.html).

RePrimAnd is a support library for numerical simulations of general 
relativistic magnetohydrodynamics and other neutron star related
problems. RePrimAnd provides 

* A general framework for handling matter equations of state, 
* A solver for the TOV equations describing nonrotating neutron stars
* Tools for precomputing properties for sequences of neutron stars.
* Methods for recovering primitive variables in GRMHD. This is not 
  included in the Python interface because it is mainly needed for 
  high performance computing.

## Documentation

The documentation for the library and the Python interface 
can be found [here](https://wokast.github.io/RePrimAnd/index.html)

## Installation

For the Linux platform, we provide Python wheels bundled with the 
precompiled library. They can be installed from 
[pypi](https://pypi.org) using


```bash
pip install pyreprimand
```

For other platforms, including Macs, one would first have to build
and install the reprimand library from 
source (see [here](https://github.com/wokast/RePrimAnd)).
Installing pyreprimand with pip will then try building from
source. This may still fail as MacOS is not the development platform.
In this case, please open a ticket on the issue tracker


## Requirements

* The numpy package

Only when building from source distribution:

* A C++11 capable compiler (tested with gcc and clang). 
* Python pybind11 package >= 2.6.0 (only for Python bindings)
* The RePrimAnd library (only when building from source dist)

## Support

In case of errors in the Python interface or the library, submit a ticket to
the [issue tracker](https://github.com/wokast/RePrimAnd/issues).



