Release 0.1.0 (#58)

Author: fsoubelet

CHANGELOG.md

@@ -0,0 +1,32 @@
+# pylhc Changelog
+
+## Version 0.1.0
+
+- Added:
+    - Job submitter script to easily generate and schedule jobs through HTCondor.
+    - Autosix script to easily generate and submit parametric SixDesk studies through HTCondor.
+    - Script to analyse forced dynamic aperture data.
+    - Scripts for logging and analysis of LHC BSRT data.
+    - Utility modules supporting functionality for the above scripts.
+
+- Changed:
+    - License moved to GNU GPLv3 to comply with the use of the `omc3` package.
+
+- Miscellaneous:
+    - Introduced extra dependencies tailored to different use cases of the package.
+    - Reworked package organisation for consistency.
+    - Set minimum requirements versions.
+    - Moved CI/CD setup to Github Actions.
+    - Improved testing and test coverage.
+
+## Version 0.0.2
+
+No changes somehow.
+
+## Version 0.0.1
+
+- Added:
+    - Script to retrieve machine settings information.
+
+- Removed:
+    - All previous outdated files.

README.md

@@ -10,13 +10,17 @@ This package is a collection of useful scripts and tools for the Optics Measurem
 
 ## Documentation
 
-- Autogenerated docs via ``sphinx`` can be found on <https://pylhc.github.io/PyLHC/>.
-- General documentation of the OMC-Teams software on <https://pylhc.github.io/>
+- Autogenerated docs via `Sphinx` can be found at <https://pylhc.github.io/PyLHC/>.
+- General documentation of the OMC-Team is located at <https://pylhc.github.io/>
 
 ## Getting Started
 
-This  package is `Python 3.7+` compatible, but not yet deployed to PyPI.
-The best way to install is through pip and VCS:
+This package is `Python 3.7+` compatible, and can be installed through `pip`:
+```bash
+pip install pylhc
+```
+
+One can also install from VCS:
 ```bash
 git clone https://github.com/pylhc/PyLHC
 pip install /path/to/PyLHC
@@ -27,29 +31,32 @@ Or simply from the online master branch, which is stable:
 pip install git+https://github.com/pylhc/PyLHC.git#egg=pylhc
 ```
 
-After installing, codes can be run with either `python -m pylhc.SCRIPT --FLAG ARGUMENT` or calling path to the `.py` file directly.
+After installing, scripts can be run with either `python -m pylhc.SCRIPT --FLAG ARGUMENT` or by calling the `.py` files directly.
 
 Note: some of the scripts access functionality only available on the CERN Technical Network.
 To use those, you should make sure to install the relevant extra dependencies with `pip install path/to/Pylhc[tech]`.
 
 ## Description
 
-This package provides tools which can be useful for working with accelerators, but are not neccessary for optics measurements analysis.
-The latter tools can be found in [omc3](https://github.com/pylhc/omc3) (Python 3.7+) or [Beta-Beat.src](https://github.com/pylhc/Beta-Beat.src) (Python 2.7)
+This package provides tools for particle accelerator data analysis, simulations management and machine information extraction; complementing the optics measurement analysis tools of the [omc3 package](https://github.com/pylhc/omc3).
 
 ## Functionality
 
-- *HTCondor Job Submitter* - Allows to generate jobs based on a templates and submit them to HTCondor. ([**job_submitter.py**](pylhc/job_submitter.py))
-- *AutoSix* - Allows to generate and submit parametric SixDesk studies easily. ([**autosix.py**](pylhc/autosix.py))
-- *Forced DA Analysis* - Script to analyse forced DA. ([**forced_da_analysis.py**](pylhc/forced_da_analysis.py))
-- *Machine Settings Info* - Prints an overview over the machine settings at a given time. ([**machine_settings_info.py**](pylhc/machine_settings_info.py))
-- *BSRT Logger* and *BSRT Analysis* - Saves data coming straight from LHC BSRT FESA class and allows subsequent analysis. ([**bsrt_logger.py**](pylhc/bsrt_logger.py) & [**bsrt_analysis.py**](pylhc/bsrt_analysis.py) )
+- `HTCondor Job Submitter` - Allows to generate jobs based on a templates and submit them to HTCondor. ([**job_submitter.py**](pylhc/job_submitter.py))
+- `AutoSix` - Allows to generate and submit parametric SixDesk studies easily. ([**autosix.py**](pylhc/autosix.py))
+- `Forced DA Analysis` - Script to analyse forced DA. ([**forced_da_analysis.py**](pylhc/forced_da_analysis.py))
+- `Machine Settings Info` - Prints an overview over the machine settings at a given time. ([**machine_settings_info.py**](pylhc/machine_settings_info.py))
+- `BSRT Logger` and `BSRT Analysis` - Saves data coming straight from LHC BSRT FESA class and allows subsequent analysis. ([**bsrt_logger.py**](pylhc/bsrt_logger.py) & [**bsrt_analysis.py**](pylhc/bsrt_analysis.py) )
 
 ## Quality checks
 
 - Unit and accuracy tests are run automatically through CI [Github Actions](https://github.com/pylhc/PyLHC/actions). See our workflows in this [readme](.github/workflows/README.md).
 - Additional checks for code-complexity, design-rules, test-coverage and duplication are made through [CodeClimate](https://codeclimate.com/github/pylhc/PyLHC).
-- Pull requests implementing functionality or fixes are merged into the master branch after passing CI, and a reviewer's approval.
+- Pull requests implementing functionality or fixes are merged into the master branch after passing CI, and getting a reviewer's approval.
+
+### Changelog
+
+See the [CHANGELOG](CHANGELOG.md) file.
 
 ### Hints for Developers
 
@@ -74,4 +81,5 @@ Open an issue, make your changes in a branch and submit a pull request.
 * **pyLHC/OMC-Team** - *Working Group* - [pyLHC](https://github.com/orgs/pylhc/teams/omc-team)
 
 ## License
+
 This project is licensed under the `GNU GPLv3` License - see the [LICENSE](LICENSE) file for details.

pylhc/__init__.py

@@ -10,7 +10,7 @@
 __title__ = "pylhc"
 __description__ = "An accelerator physics script collection for the OMC team at CERN."
 __url__ = "https://github.com/pylhc/pylhc"
-__version__ = "0.0.3"
+__version__ = "0.1.0"
 __author__ = "pylhc"
 __author_email__ = "[email protected]"
 __license__ = "MIT"