..
Automatic created file. Don't edit
Uttrs
=====
``uttrs`` seeks to interoperate Classes definided using attrs and *astropy units* in a simple manner.
.. image:: https://github.com/quatrope/uttrs/blob/main/res/ugly_logo.png?raw=true
:target: https://github.com/quatrope/uttrs/blob/main/res/ugly_logo.png?raw=true
:alt: img
----
.. image:: https://img.shields.io/badge/QuatroPe-Applications-1c5896
:target: https://quatrope.github.io/
:alt: QuatroPe
.. image:: https://travis-ci.com/quatrope/uttrs.svg?branch=main
:target: https://travis-ci.com/quatrope/uttrs
:alt: Build Status
.. image:: https://readthedocs.org/projects/uttrs/badge/?version=latest
:target: https://uttrs.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/pypi/l/uttrs?color=blue
:target: https://www.tldrlegal.com/l/bsd3
:alt: License
.. image:: https://img.shields.io/badge/python-3.8+-blue.svg
:target: https://badge.fury.io/py/uttrs
:alt: Python 3.8+
.. image:: https://img.shields.io/pypi/v/uttrs
:target: https://pypi.org/project/uttrs/
:alt: PyPI
**uttrs** is mainly three functions:
* ``uttr.ib`` which generates attributes sensitive to units.
* ``uttr.array_accessor`` which allows access to attributes linked to units, and transform them into numpy arrays.
* ``uttr.s`` a class decorator to automatically add the ``array_accessor``.
Code and issues
---------------
The entire source code of is hosted in GitHub
`https://github.com/quatrope/uttrs/ `_
License
-------
Uttrs is under
`The BSD-3 License `_
The BSD 3-clause license allows you almost unlimited freedom with the software so long as you include the BSD copyright and license notice in it (found in Fulltext).
Installation
------------
This is the recommended way to install uttrs.
Installing with pip
^^^^^^^^^^^^^^^^^^^^
Make sure that the Python interpreter can load uttrs code.
The most convenient way to do this is to use virtualenv, virtualenvwrapper, and pip.
After setting up and activating the virtualenv, run the following command:
.. code-block:: console
$ pip install uttrs
...
That should be it all.
Installing the development version
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you’d like to be able to update your uttrs code occasionally with the latest bug fixes and improvements, follow these instructions:
Make sure that you have Git installed and that you can run its commands from a shell.
(Enter *git help* at a shell prompt to test this.)
Check out uttrs main development branch like so:
.. code-block:: console
$ git clone https://github.com/quatrope/uttrs
...
This will create a directory *uttrs* in your current directory.
Then you can proceed to install with the commands
.. code-block:: console
$ cd uttrs
$ pip install -e .
...
Documentation
-------------
The full documentation of the project are available in
`https://uttrs.readthedocs.io/ `_
Contact
-------
For bugs or question please contact
..
**Juan B. Cabral:** `jbcabral@unc.edu.ar `_
Quick Start
-----------
The following piece of code is an example prototype of a Class representing a Galaxy.
The Galaxy contains:
* three arrays (\ ``x``\ , ``y``\ , ``z``\ ) with particle positions, measured in *kiloparsecs* (\ ``u.kpc``\ ).
* three arrays (\ ``vx``\ , ``vy``\ , ``vz``\ ) for the particle velocities, measured in *Km/s* (\ ``u.kms/u.s``\ ).
* an array (\ ``m``\ ) of particle masses, expressed in *solar masses* (\ ``u.M_sun``\ ).
* a free text for note taking in ``notes``.
In every case we would like to access to position, velocity and mass of the particles, with and without units (as ``np.ndarray``\ ).
Suggested units in the information of the attributes behave like this:
* If the user makes the class instance without unit specification then default assumed unit is used.
* If, otherwise, another unit is used as input, it is validated the feasibility of the conversion to default unit.
.. code-block:: python
import uttr
import astropy.units as u
@uttr.s
class Galaxy:
x = uttr.ib(unit=u.kpc)
y = uttr.ib(unit=u.kpc)
z = uttr.ib(unit=u.kpc)
vx = uttr.ib(unit=u.km/u.s)
vy = uttr.ib(unit=u.km/u.s)
vz = uttr.ib(unit=u.km/u.s)
m = uttr.ib(unit=u.M_sun)
notes = uttr.ib(converter=str)
Creating a galaxy
-----------------
.. code-block:: python
>>> import numpy as np
>>> import astropy.units as u
# Creating the particle arrays
>>> x = np.random.randint(1000, 10_000, size=5) + np.random.rand(5)
>>> y = np.random.randint(1000, 10_000, size=5) + np.random.rand(5)
>>> z = np.random.randint(1000, 10_000, size=5) + np.random.rand(5)
>>> vx = np.random.randint(1000, 10_000, size=5) + np.random.rand(5)
>>> vy = np.random.randint(1000, 10_000, size=5) + np.random.rand(5)
>>> vz = np.random.randint(1000, 10_000, size=5) + np.random.rand(5)
>>> m = np.random.randint(1000, 10_000, size=5) + np.random.rand(5)
>>> gal = Galaxy(
... x = x * u.kpc, # kpc is the suggested unit
... y = y * u.mpc, # milliparsec is equivalent to kpc
... z = z, # we assume is the suggested kpc unit
... vx = vx * (u.km/u.s), # the suggested unit
... vy = vy * (u.km/u.s), # the suggested unit
... vz = vz, # the suggested unit
... m = m * u.M_sun, # the suggested unit
... notes="a random galaxy made with random numbers")
>>> gal
Galaxy(
x=,
y=,
z=,
vx=,
vy=,
vz=,
m=,
notes='a random galaxy made with random numbers')
# we can access al the attributes in the traditional python way
>>> gal.x
>>> gal.vz # z is now a km/s
# We stored y as mpc (milliparsec)
>>> gal.y
Simple interaction with ``numpy.ndarray``
---------------------------------------------
We can access all the same attributes declared with ``uttr.ib but`` coerced to the default unit as numpy array.
.. code-block:: python
>>> gal.arr_.y
array([0.00809345, 0.00219855, 0.00546479, 0.00186072, 0.00363664])
The above code is equivalent to
.. code-block:: python
>>> gal.y.to_value(u.kpc)
array([0.00809345, 0.00219855, 0.00546479, 0.00186072, 0.00363664])
Equivalent units errors
-----------------------
If we change the unit to something not equivalent to the default unit
declares in ``uttr.ib`` an exception is raised.
Lets fot example define ``x`` as a kilogram (\ ``u.kg``\ )
.. code-block:: python
>>> gal = Galaxy(
... x = x * u.kg, # kg is not equivalent to kpc
... y = y,
... z = z,
... vx = vx,
... vy = vy,
... vz = vz,
... m = m,
... notes="a random galaxy made with random numbers")
ValueError: Unit of attribute 'x' must be equivalent to 'kpc'.Found 'kg'.
References
----------
Astropy
^^^^^^^
..
Price-Whelan, Adrian M., et al. "The Astropy project:
Building an open-science project and status of the v2. 0 core
package." The Astronomical Journal 156.3 (2018): 123.
Contents:
---------
.. toctree::
:maxdepth: 3
tutorial.ipynb
api.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`