think 0.1 is done

quatrope · Nov 17, 2020 · 42ebc8c · 42ebc8c
1 parent 471957d
commit 42ebc8c
Show file tree

Hide file tree

Showing 7 changed files with 86 additions and 255 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2020, QuatroPe
+Copyright (c) 2020, Juan B Cabral and QuatroPe.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -2,7 +2,6 @@ include LICENSE
 include README.md
 include CODE_OF_CONDUCT.md
 
-recursive-exclude draft *
 recursive-exclude res *
 
 exclude test_*.py

diff --git a/README.md b/README.md
@@ -8,12 +8,29 @@
 [![License](https://img.shields.io/pypi/l/uttrs?color=blue)](https://tldrlegal.com/license/bsd-3-clause-license-(revised))
 [![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://badge.fury.io/py/uttrs)
 
-
+**uttrs** is mainly two 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.
 
-The following piece of code is an exampl prototype of a Class representing a Galaxy.
+## Installing
+
+- From PyPI
+
+```s
+$ pip install uttrs
+```
+
+- Simply clone and from within the repo
+
+```s
+$ pip install -e .
+```
+
+
+## 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`).
@@ -136,3 +153,12 @@ Lets fot example define `x` as a kilogram (`u.kg`)
 
 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.
diff --git a/draft/draft.ipynb b/draft/draft.ipynb
diff --git a/setup.py b/setup.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2019, Juan B Cabral
+# Copyright (c) 2020, Juan B Cabral and QuatroPe.
 # License: BSD-3-Clause
 #   Full Text: https://github.com/quatrope/uttrs/blob/master/LICENSE
 
@@ -66,7 +66,7 @@
     description=DESCRIPTION,
     long_description=LONG_DESCRIPTION,
     long_description_content_type="text/markdown",
-    author="QuatroPe",
+    author="JB Cabral and QuatroPe",
     author_email="jbcabral@unc.edu.ar",
     url="https://github.com/quatrope/utts",
     license="3 Clause BSD",
@@ -77,7 +77,7 @@
         "units",
         "astropy",
     ],
-    classifiers=(
+    classifiers=[
         "Development Status :: 4 - Beta",
         "Intended Audience :: Education",
         "Intended Audience :: Science/Research",
@@ -87,7 +87,7 @@
         "Programming Language :: Python :: 3",
         "Programming Language :: Python :: Implementation :: CPython",
         "Topic :: Scientific/Engineering",
-    ),
+    ],
     py_modules=["uttr", "ez_setup"],
     install_requires=REQUIREMENTS,
 )