eida-embargo-roller 1.0.0

No project description provided

EIDA Embargo Roller

Description

This program processes a stationXML file and updates channel epochs to reflect the specified embargo start date while maintaining the original structure of the data.

1. If the channel epoch ends before the embargo: No changes are made.
2. If the channel epoch ends after the embargo:
   • If the epoch starts before the embargo and the restriction policy is closed, the epoch is split at the embargo date:
     1. The restriction policy before the embargo is forced to open.
     2. The restriction policy after the embargo remains closed.
3. After processing, the program merges contiguous channels with matching embargo statuses while keeping track of comments.

Additionally, channels are sorted alphabetically by name and chronologically by start date.

---

Usage

eida_embargo_roller [-i] [-e YYYY-MM-DD] station.xml

Options:

• -i: Transform the stationXML file in place.
• -e: Embargo start date. All channels before this date will have their restriction policy changed to open.
• --allow-partial: If enabled, allows partial restriction statuses instead of converting them to open.

---

Installation Guide for EIDA Embargo Roller

Recommended: Using UV

1. Install UV

If uv is not already installed, follow this guide.

2. Install and Run the Script

• On Windows:

  uvx eida-embargo-roller -e YYYY-MM-DD station.xml
  

• On Linux: (due to different executable naming)

  uvx --from eida-embargo-roller eida_embargo_roller -e YYYY-MM-DD station.xml
  

---

Alternative: Installing from Source

If you prefer to install manually, you can download and run the script from the repository.

1. Clone the Repository

git clone https://github.com/EIDA/embargo-roller.git
cd embargo-roller

2. Install Dependencies

uv sync

3. Run the Script

uv run eida_embargo_roller -e YYYY-MM-DD station.xml

---

Rust and Cargo Requirement

Certain dependencies (e.g., pendulum) require Rust and Cargo to build. If you encounter errors such as maturin failing due to missing Cargo, install Rust and Cargo by following the official Rust installation guide.

Testing & Debugging

Running Tests

To run the entire test suite using pytest:

uvx pytest

Example Debug Output:

2024-06-17 12:00:00 - __main__ - DEBUG - Processing Channel: {'code': 'CH1', 'startDate': '2020-01-01T00:00:00'}
2024-06-17 12:00:00 - __main__ - DEBUG - Comparing with Previous Channel: {'code': 'CH1', 'endDate': '2020-06-01T00:00:00'}
2024-06-17 12:00:00 - __main__ - DEBUG - Channels merged successfully.

---

Notes

• The program does not modify station metadata beyond embargo-related changes.
• Sorting is performed alphabetically by channel name and chronologically by start date.
• Merging ensures only on channels with embargo-related comments .