Skip to content

A tool to simulate saltwater intrusion through the Neo-Panamax locks of the Panama Canal

License

Notifications You must be signed in to change notification settings

mgcastre/NPXsim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

182 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NPXsim

DOI Python Version License: MIT

The Neo-Panamax lock simulator (NPXsim) is a model to simulate saltwater intrusion through the Neo-Panamax (NPX) locks of the Panama Canal. It consists of a mass balance that represents the exchanges of water and salt that take place between lock chambers and water saving basins (WSBs) as a result of vessel transit.

In its current implementation, NPXsim is tailor-made to simulate the operations of the NPX locks. However, it is possible to adapt it for the simulation of lock operations in any three-steps lock system with or without the use of WSBs.

🚧 Status: Under Construction

The documentation for this repository is currently being developed. Please check back soon for detailed usage guides, API references, and more comprehensive examples.


🚀 Installation Guide

This project uses uv for environment and package management.

  1. Ensure you have uv installed. If not, you can install it by following the official documentation.

  2. Clone this repository to a local directory:

git clone https://github.com/mgcastre/NPXsim.git
cd NPXsim
  1. Use the following command to create a virtual environment and install all dependencies exactly as defined in the uv.lock file:
uv sync
  1. Activate the isolated environment to start working:

macOS/Linux:

source .venv/bin/activate

Windows:

.venv\Scripts\activate

📖 Basic Usage

A minimal code example demonstrating how to initialize and run the NPXsim model is provided in the examples folder.

🎓 Citation

If you use this software in your research, please cite the Zenodo DOI:

Castrellón, M. G. (2026). NPXsim: A tool to simulate saltwater intrusion through the Neo-Panamax locks. Zenodo. https://doi.org/10.5281/zenodo.18362372

📄 License

This project is licensed under the MIT License.


Created as part of PhD Research at IHE Delft Institute for Water Education and TU Delft.

About

A tool to simulate saltwater intrusion through the Neo-Panamax locks of the Panama Canal

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages