Plotting hotfixes (#54)

fsoubelet · Sep 14, 2021 · aa5c0d4 · aa5c0d4
1 parent 0c95013
commit aa5c0d4
Show file tree

Hide file tree

Showing 49 changed files with 1,765 additions and 1,489 deletions.
diff --git a/docs/About_PyhDToolkit.md b/docs/About_PyhDToolkit.md
@@ -11,11 +11,11 @@ For now, `PyhDToolkit` provides some of the following features:
 
 - A `cpymadtools` module with tools building on [`cpymad`][cpymad], a Python bindings library for the [`MAD-X`][madx] code; including generators, matching routines, plotting utilities etc.
 - A `maths` module for useful methods used in analysis.
+- A `models` module for useful [`pydantic`][pydantic]-validated models used in the package.
 - An `optics` module for particle accelerator physics related calculations and analysis.
 - A `plotting` module for various `matplotlib` helpers.
 - A `utils` module for various Python and UNIX utilities.
 
 [cpymad]: https://github.com/hibtc/cpymad
 [madx]: https://mad.web.cern.ch/mad/
-[omc3]: https://github.com/pylhc/omc3
-[tfs]: https://github.com/pylhc/tfs
+[pydantic]: https://pydantic-docs.helpmanual.io/
diff --git a/docs/Getting_Started.md b/docs/Getting_Started.md
@@ -51,6 +51,10 @@ docker run --rm -p 8888:8888 -e JUPYTER_ENABLE_LAB=yes -v <host_dir_to_mount>:/h
 
 Any jupyter notebook or Python files in the mounted directory can then be used / ran with an environment identical to mine.
 
+## Examples
+
+One can find some example notebooks showcasing use of `pyhdtoolkit` in the following [repository][workflows_repo].
+
 ## Citing
 
 If you have a use of these codes, please consider citing them.
@@ -74,5 +78,6 @@ To cite a specific version, select the version on the package's page on Zotero a
 [pip]: https://pip.pypa.io/en/stable/
 [Poetry]: https://python-poetry.org/
 [pylint_ref]: https://www.pylint.org/
+[workflows_repo]: https://github.com/fsoubelet/Workflows
 [DOI]: https://zenodo.org/badge/latestdoi/227081702
 [Zenodo]: https://zenodo.org
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyhdtoolkit/__init__.py b/pyhdtoolkit/__init__.py
@@ -13,7 +13,7 @@
 __title__ = "pyhdtoolkit"
 __description__ = "An all-in-one toolkit package to easy my Python work in my PhD."
 __url__ = "https://github.com/fsoubelet/PyhDToolkit"
-__version__ = "0.13.2"
+__version__ = "0.13.3"
 __author__ = "Felix Soubelet"
 __author_email__ = "[email protected]"
 __license__ = "MIT"