semvec/pypi-packages huggingface dataset:
processmcrat 2.0.1
The ProcessMCRaT library is a python package that can be used to process the output of the MCRaT code.
License: MIT
Requires Python: >=3.3
Keywords: astronomy radiation-transfer hydrodynamics

====================
ProcessMCRaT Library
====================


The ProcessMCRaT library is a python package that can be used to process the output of the MCRaT code.


About The Project
=================

The ProcessMCRaT package allows for the outputs of the MCRaT simulations to be processed in a number of different ways. The package allows the user to quickly analyze the MCRaT simulation by conveniently creating a number of mock observations for a variety of observer viewing angles and then use those observations to calculate spectra, light curves, and polarizations. The package also includes convenience plotting functions that allow quick, convenient plotting of these various quantities to fully explore the MCRaT results. These functions are also meant to be examples of how to work with the outputs of the ProcessMCRaT library. Additionally, the package also includes support for analyzing the position of photons in a given hydrodynamic simulation, allowing for analysis of hydrodynamic structures and mock observables at the same time.

There is also a Jupyter notebook that is included on Github that outlines the usage of the library, and many functionalities that the library offers. This notebook can be accessed by cloning the repository or loading the notebook in Binder at the following link `https://mybinder.org/v2/gh/parsotat/ProcessMCRaT/HEAD?filepath=notebooks%2Fprocessmcrat_example.ipynb <https://mybinder.org/v2/gh/parsotat/ProcessMCRaT/HEAD?filepath=notebooks%2Fprocessmcrat_example.ipynb>`_ . The detailed documentation for each function is still under development, but the Jupyter notebook covers the ways that each function can be used.


Contact
=======

Tyler Parsotan - `Personal Website <https://http://sites.science.oregonstate.edu/~parsotat/>`_ - parsotat@umbc.edu

Project Link: `https://github.com/parsotat/ProcessMCRaT <https://github.com/parsotat/ProcessMCRaT>`_


Acknowledgements
================

* In using ProcessMCRaT and the MCRaT codes, we ask that you cite the following papers: 

	* `Lazzati (2016) <https://doi.org/10.3847/0004\-637X/829/2/76>`_

	* `Parsotan & Lazzati (2018) <https://doi.org/10.3847/1538\-4357/aaa087>`_

	* `Parsotan et al. (2018) <https://doi.org/10.3847/1538\-4357/aaeed1>`_

	* `Parsotan et. al. (2020) <https://doi.org/10.3847/1538\-4357/ab910f>`_
       
        * `Parsotan & Lazzati (2021) <https://doi.org/10.3847/1538-4357/ac2428>`_
        
        * `Parsotan & Lazzati (2022) <https://doi.org/10.3847/1538-4357/ac4093>`_
ProcessMCRaT 2.0.1
The ProcessMCRaT library is a python package that can be used to process the output of the MCRaT code.
License: MIT
Requires Python: >=3.3
Keywords: astronomy radiation-transfer hydrodynamics

====================
ProcessMCRaT Library
====================


The ProcessMCRaT library is a python package that can be used to process the output of the MCRaT code.


About The Project
=================

The ProcessMCRaT package allows for the outputs of the MCRaT simulations to be processed in a number of different ways. The package allows the user to quickly analyze the MCRaT simulation by conveniently creating a number of mock observations for a variety of observer viewing angles and then use those observations to calculate spectra, light curves, and polarizations. The package also includes convenience plotting functions that allow quick, convenient plotting of these various quantities to fully explore the MCRaT results. These functions are also meant to be examples of how to work with the outputs of the ProcessMCRaT library. Additionally, the package also includes support for analyzing the position of photons in a given hydrodynamic simulation, allowing for analysis of hydrodynamic structures and mock observables at the same time.

There is also a Jupyter notebook that is included on Github that outlines the usage of the library, and many functionalities that the library offers. This notebook can be accessed by cloning the repository or loading the notebook in Binder at the following link `https://mybinder.org/v2/gh/parsotat/ProcessMCRaT/HEAD?filepath=notebooks%2Fprocessmcrat_example.ipynb <https://mybinder.org/v2/gh/parsotat/ProcessMCRaT/HEAD?filepath=notebooks%2Fprocessmcrat_example.ipynb>`_ . The detailed documentation for each function is still under development, but the Jupyter notebook covers the ways that each function can be used.


Contact
=======

Tyler Parsotan - `Personal Website <https://http://sites.science.oregonstate.edu/~parsotat/>`_ - parsotat@umbc.edu

Project Link: `https://github.com/parsotat/ProcessMCRaT <https://github.com/parsotat/ProcessMCRaT>`_


Acknowledgements
================

* In using ProcessMCRaT and the MCRaT codes, we ask that you cite the following papers: 

	* `Lazzati (2016) <https://doi.org/10.3847/0004\-637X/829/2/76>`_

	* `Parsotan & Lazzati (2018) <https://doi.org/10.3847/1538\-4357/aaa087>`_

	* `Parsotan et al. (2018) <https://doi.org/10.3847/1538\-4357/aaeed1>`_

	* `Parsotan et. al. (2020) <https://doi.org/10.3847/1538\-4357/ab910f>`_
       
        * `Parsotan & Lazzati (2021) <https://doi.org/10.3847/1538-4357/ac2428>`_
        
        * `Parsotan & Lazzati (2022) <https://doi.org/10.3847/1538-4357/ac4093>`_
documented 0.1.4
Templated docstrings for Python classes.
License: MIT
Requires Python: >=3.8.1,<4.0

# documented

[![Python Version](https://img.shields.io/pypi/pyversions/documented.svg)](https://pypi.org/project/documented/)
[![wemake-python-styleguide](https://img.shields.io/badge/style-wemake-000000.svg)](https://github.com/wemake-services/wemake-python-styleguide)
![PyPI - License](https://img.shields.io/pypi/l/documented)

Templated docstrings for Python classes.

## Features

- Describe your business logic in docstrings of your classes and exceptions;
- When printing an object or an exception, the library will substitute the placeholders in the docstring text with runtime values,
- And you (or your user) will see a human-readable text.

## Installation

```bash
pip install documented
```


## Example

```python
from dataclasses import dataclass
from documented import DocumentedError


@dataclass
class InsufficientWizardryLevel(DocumentedError):
    """
    🧙 Your level of wizardry is insufficient ☹

        Spell: {self.spell}
        Minimum level required: {self.required_level}
        Actual level: {self.actual_level} {self.comment}

    Unseen University will be happy to assist in your training! 🎓
    """

    spell: str
    required_level: int
    actual_level: int

    @property
    def comment(self) -> str:
        if self.actual_level <= 0:
            return '(You are Rincewind, right? Hi!)'
        else:
            return ''


raise InsufficientWizardryLevel(
    spell='Animal transformation',
    required_level=8,
    actual_level=0,
)
```

which prints:

```
---------------------------------------------------------------------
InsufficientWizardryLevel           Traceback (most recent call last)
<ipython-input-1-d8ccdb953cf6> in <module>
     27 
     28 
---> 29 raise InsufficientWizardryLevel(
     30     spell='Animal transformation',
     31     required_level=8,

InsufficientWizardryLevel: 
🧙 Your level of wizardry is insufficient ☹

    Spell: Animal transformation
    Minimum level required: 8
    Actual level: 0 (You are Rincewind, right? Hi!)

Unseen University will be happy to assist in your training! 🎓
```

For more examples, see: https://anatoly-scherbakov.github.io/documented/

This project was generated with [`wemake-python-package`](https://github.com/wemake-services/wemake-python-package).