The following code is the most recent version of combined Hydrocode RocfluMP and particle-tracker ppiclF.

April 8, 2025 · View on GitHub

📘 Documentations:

You can find the full RocfluMP manual here.

Documentation Website for ppiclF here.

Follow these steps to get a copy of the project up and running on your machine or HiPerGator account.

Click the Fork button at the top-right of this page to create your own copy of the repository.

git clone https://github.com/your-username/your-repo-name.git
cd your-repo-name

Generate an SSH key (if you don’t already have one):

ssh-keygen -t ed25519 -C "your_email@example.com"

Add your SSH key to the ssh-agent:

eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_ed25519

Add the SSH key to your GitHub account: Display your public key with:
```
cat ~/.ssh/id_ed25519.pub
```
Go to GitHub → Settings → SSH and GPG keys → New SSH key

Paste the copied key into the field and give it a descriptive title (e.g., My Laptop or HiPerGator).

Clone your fork using SSH:

git clone git@github.com:your-username/your-repo-name.git
cd your-repo-name

Once you’ve cloned your fork of the repository, here are the basic Git commands you’ll use when contributing to the project:

Before making changes, make sure your local branch is up to date with the main project:

git fetch upstream
git checkout main
git merge upstream/main

It's good practice to make changes on a separate branch, not directly on main.

git checkout -b feature/your-branch-name

Edit the files you need using your favorite editor or IDE.

git add .
git commit -m "Descriptive message of what you changed"

git push origin feature/your-branch-name

Use .gitignore (already found in your cloned directory) to avoid committing unwanted files.
Run git status often to check what’s staged or modified.
Run git log --oneline to view your commit history.