Instradatore

Instradatore is a Python project designed to manage the execution of a sequential chain of Python and Bash scripts. Its goal is to simplify workflows by executing scripts in a predefined order, ensuring that dependencies and execution logic are respected.

---

Features

• Sequential execution: Automatically runs Python and Bash scripts in order.
• Configuration flexibility: Define execution sequences in a configuration file.
• Dependencies included: Utilizes modern Python libraries like pyyaml and rich-click for enhanced functionality.
• Support for NetCDF and HDF5: Includes tools for handling scientific data with xarray, netcdf4, and h5netcdf.
• Documentation-ready: Bundled with Sphinx and themes for creating beautiful documentation.
• HTML Report Generation: Automatically generates an HTML report detailing the execution of scripts, providing insights into the workflow.

---

Installation

Prerequisites

• Python 3.10 or later.
• Poetry for dependency management and project packaging.

Steps

1. Clone the repository:

   git clone https://github.com/fgr81/instradatore.git
   cd instradatore

2. Install dependencies using Poetry:

   poetry install

3. Activate the Poetry virtual environment:

   poetry shell

---

Usage

1. Define the execution sequence in a scripts.yaml file.

   • Example ames_34.yaml

2. Run Instradatore using the following command, specifying any desired options or commands:

   python -m instradatore [OPTIONS] COMMAND [ARGS]...

   • Available options:

     • --log TEXT: Specify the log file location.
     • --daemon, -d: Run in background mode.

   • Available commands:

     • start: Start the execution of the script chain.

---

Development

Adding Dependencies

To add a new dependency, use Poetry:

poetry add <package-name>

Generating Documentation

Instradatore uses Sphinx for documentation. To build the docs:

cd docs
sphinx-build -b html source/ build/

The output will be available in the docs/build/ directory.

---

Dependencies

Instradatore leverages the following key Python libraries:

• pyyaml: For parsing YAML configuration files.
• rich-click: For enhanced CLI output.
• xarray: For multidimensional scientific data processing.
• netcdf4: For working with NetCDF files.
• h5netcdf: For NetCDF compatibility with HDF5.
• Sphinx: For generating documentation.

---

Contributing

We welcome contributions! To contribute:

1. Fork the repository.
2. Create a branch for your feature or bugfix:

   git checkout -b feature-name

3. Commit your changes:

   git commit -m "Description of your changes"

4. Push to your fork:

   git push origin feature-name

5. Open a Pull Request.

---

License

This project is licensed under the GNU GPLv3.

---

Author

Developed by Fabio Massimo Grasso
📧 Email: [email protected]
🌐 GitHub Profile