Multiple changes (#21)

- add docstrings and type hints
- rename _Base to Object
- move length property to Object
- update __str__ function of Object
- update gitignore

- Changes size of some arrays:
- removed identity matrix from acc_array
  now has size of n_kicks
- step_size array now has size of n_kicks
- orbit position now has sizeo of n_kicks + 1
- also updated c files accordingly

- added user guide dba example
- added test for removing and adding objects to cell
- some code refactoring

Author: felix-andreas

.gitignore

@@ -1,13 +1,15 @@
+# OS and IDE
 .DS_Store
-.env
+.idea
+.vscode
+
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
 *$py.class
 
 # C extensions
-# TODO: .o/.c files should be deleted automatically
 apace/**/*.so
 apace/**/*.o
 apace/**/*.c
@@ -18,12 +20,18 @@ apace/**/*.c
 build/
 dist/
 sdist/
+wheels/
 *.egg
 *.egg-info/
 
-# IDE
-.idea
-.vscode
+# Unit test / coverage reports
+.pytest_cache/
+
+# Sphinx documentation
+docs/_build/
+
+# Enviroments
+.env
 
 # output
 output/

MANIFEST.in

@@ -1,4 +1,12 @@
+include *.in
 recursive-include cffi_build *.py
+recursive-include docs *.bat
+recursive-include docs *.gitkeep
+recursive-include docs *.py
+recursive-include docs *.rst
+recursive-include docs *.txt
+recursive-include docs Makefile
+prune docs/_build
 recursive-include examples *.json
 recursive-include examples *.py
 recursive-include lib *.c

README.md

@@ -2,7 +2,7 @@
 [![Python Version](https://img.shields.io/pypi/pyversions/apace)](https://pypi.org/project/apace/)
 [![PyPI](https://img.shields.io/pypi/v/apace.svg)](https://pypi.org/project/apace/)
 [![CI](https://github.com/andreasfelix/apace/workflows/CI/badge.svg)](https://github.com/andreasfelix/apace/actions?query=workflow%3ACI)
-[![Docs](https://readthedocs.org/projects/apace/badge/?version=docs)](https://apace.readthedocs.io/en/docs/)
+[![Docs](https://readthedocs.org/projects/apace/badge/?version=latest)](https://apace.readthedocs.io/en/docs/)
 
 **apace** is yet **a**nother **p**article **a**ccelerator **c**od**e** designed for the optimization of beam optics. It is available as Python package and aims to provide a convenient and straightforward API to make use of Python's numerous scientific libraries.
 
@@ -15,7 +15,7 @@ pip install -U apace
 ```
 
 ## Requirements
-- Python 3.7 or higher (CPython or PyPy)
+- Python 3.6 or higher (CPython or PyPy)
 - CFFI 1.0.0 or higher
 - NumPy/SciPy
 - Matplotlib
@@ -42,7 +42,6 @@ Calculate the Twiss parameters:
 twiss = ap.Twiss(ring)
 ```
 
-
 Plot horizontal and vertical beta functions using matplotlib:
 ```python
 import matplotlib.pyplot as plt

apace/__about__.py

@@ -4,4 +4,3 @@
 __version__ = '0.0.1'
 __author__ = 'Felix Andreas'
 __license__ = 'GNU General Public License v3.0'
-__copyright__ = 'Copyright 2019 Felix Andreas'

apace/__init__.py

@@ -1,8 +1,8 @@
-from .__about__ import __license__, __author__, __version__, __copyright__
-from .classes import Drift, Bend, Quad, Sext, Cell
-from .matrix_method import MatrixMethod
-from .matrix_tracking import MatrixTracking
+from .__about__ import __version__, __license__, __author__
+from .classes import Object, Element, Drift, Bend, Quad, Sext, Octu, Cell
+from .io import load_lattice, save_lattice
 from .twiss import Twiss
-from .io import read_lattice_file, save_lattice_file
+from .matrix_tracking import MatrixTracking
 from .distributions import create_particle_distribution
+from .matrix_method import MatrixMethod
 from .utils import Signal, AmbiguousNameError