Merge pull request #85 from VERITAS-Observatory/add-towncrier

Add towncrier and changelog.

Author: GernotMaier

.pre-commit-config.yaml

@@ -1,32 +1,32 @@
 repos:
   # https://pycqa.github.io/isort/docs/configuration/black_compatibility.html#integration-with-pre-commit
   - repo: https://github.com/pycqa/isort
-    rev: 5.13.2
+    rev: 7.0.0
     hooks:
       - id: isort
         args: ["--profile", "black", "--filter-files"]
   - repo: https://github.com/psf/black
-    rev: 24.10.0
+    rev: 25.12.0
     hooks:
       - id: black
         args: ["--line-length=100"]
   # https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html?highlight=other%20tools#flake8
   - repo: https://github.com/PyCQA/flake8
-    rev: 7.1.1
+    rev: 7.3.0
     hooks:
       - id: flake8
         args: ["--max-line-length=100", "--extend-ignore=E203,E712"]
   # https://github.com/pre-commit/pre-commit-hooks
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-executables-have-shebangs
       - id: check-shebang-scripts-are-executable
   # codespell
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
+    rev: v2.4.1
     hooks:
       - id: codespell
         args: [

CHANGELOG.md

@@ -0,0 +1,10 @@
+# CHANGELOG
+
+All notable changes to the Eventdisplay_AnalysisFiles_VTS/ project will be documented in this file.
+Changes for upcoming releases can be found in the [docs/changes](docs/changes) directory.
+Note that changes before release v492.0 are not documented here, but can be found in the
+[GitHub repository](https://github.com/VERITAS-Observatory/Eventdisplay_AnalysisFiles_VTS/releases).
+
+This changelog is generated using [Towncrier](https://towncrier.readthedocs.io/).
+
+<!-- towncrier release notes start -->

README.md

@@ -9,7 +9,7 @@ The version of Eventdisplay for this repository can be found in the files [IRFVE
 
 The analysis requires additional IRF files (lookup tables, gamma-hadron BDT trees, etc) which are too big for this repository. These files are available through the UCLA archive or direct download from DESY disks (restricted access).
 
-To download and unpack the IRFs from the UCLA archive, run in the Eventdisplay\_AnalysisFiles directory:
+To download and unpack the IRFs from the UCLA archive, run in the Eventdisplay\_AnalysisFiles\_VTS directory:
 
 ```bash
 ./download_irfs.sh transfer/file_list_V6.dat
@@ -18,11 +18,11 @@ To download and unpack the IRFs from the UCLA archive, run in the Eventdisplay\_
 
 Total download size is about 190 GBytes.
 
-Further information on this release see the [Eventdisplay v491 release page](https://github.com/VERITAS-Observatory/EventDisplay_Release_v491/blob/main/README.md) (restricted access).
+For further information on this release, see the [Eventdisplay v491 release page](https://github.com/VERITAS-Observatory/EventDisplay_Release_v491/blob/main/README.md) (restricted access).
 
 Following directories and files are available:
 
-Parameter Files
+ParameterFiles:
 
 - parameter files required for running most steps of Eventdisplay
 - EVNDISP.global.runparameter (global parameters like VERITAS position; URL of VERITAS DB; location of VERITAS raw data archive)
@@ -43,13 +43,13 @@ AstroData:
 
 - example catalogs and typical Crab Nebula spectra
 
-Calibration
+Calibration:
 
 - low-gain calibration files required for Eventdisplay analysis
 - pulse-shapes used in CARE simulations (Calibration/CareSimulations)
 - example file for calibration list to be used to overwrite DB flasher/laser values in the analysis (Calibration/calibrationlist.dat)
 
-DetectorGeometry
+DetectorGeometry:
 
 - configuration files for pixel and telescope positions
 
@@ -67,24 +67,24 @@ For version changes, the following files need to be changed:
 
 ### Uploading IRF files
 
-1. Pack IRF files into several tar packages
+1. Pack IRF files into several tar packages (scripts are located in the `transfer/` directory)
 
 ```bash
-./pack_irfs_for_ucla.sh
+./transfer/pack_irfs_for_ucla.sh
 ```
 
 2. Inspect tar packages in the directory `tar_packages` and move them to the directory `archive`
 
-3. Upload files to UCLA
+3. Upload files to UCLA (scripts are located in the `transfer/` directory)
 
 ```bash
-./put_irfs_to_ucla.sh
+./transfer/put_irfs_to_ucla.sh
 ```
 
-4. Test some uploads with downloading script (modify, to not download again everything):
+4. Test some uploads with the downloading script (modify to avoid downloading everything again):
 
 ```bash
-./download_irfs_from_ucla.sh transfer/file_list_V6.dat
+./download_irfs.sh transfer/file_list_V6.dat
 ```
 
 Note that for DESY users, the tar packages are not downloaded but copied from their archive location.

docs/changes/.gitkeep

@@ -0,0 +1 @@
+Add Changelog and automatic changelog generation using towncrier.

docs/changes/85.maintenance.md

@@ -0,0 +1,23 @@
+[tool.towncrier]
+name = "Eventdisplay_AnalysisFiles_VTS"
+directory = "docs/changes"
+filename = "CHANGELOG.md"
+title_format = "## [{version}](https://github.com/VERITAS-Observatory/Eventdisplay_AnalysisFiles_VTS/releases/tag/{version}) - {project_date}"
+issue_format = "[#{issue}](https://github.com/VERITAS-Observatory/Eventdisplay_AnalysisFiles_VTS/issues/{issue})"
+start_string = "<!-- towncrier release notes start -->\n"
+
+[tool.towncrier.fragment.feature]
+name = "New Feature"
+showcontent = true
+
+[tool.towncrier.fragment.bugfix]
+name = "Bugfixes"
+showcontent = true
+
+[tool.towncrier.fragment.maintenance]
+name = "Maintenance"
+showcontent = true
+
+[tool.towncrier.fragment.doc]
+name = "Documentation"
+showcontent = true