File	Date	Author	Commit
README	2025-03-14	Håkan Nilsson	[f2a143] Updated README file

Read Me

The TurboTools Git repository is a collection of applications and libraries
designed for the purpose of turbomachinery simulations using various versions of
OpenFOAM.

The 'master' branch only contains this README file, with instructions on how to
extract the various tools available for a given OpenFOAM flavour.

The other branches serve to host the applications and libraries source
code adapted for a specific version of OpenFOAM, for example:

   - foam-extend-5.0
   - ESI-OpenFOAM-v2206
   - ESI-OpenFOAM-v2312
   - ESI-OpenFOAM-v2406
   - ESI-OpenFOAM-v2412

See https://sourceforge.net/p/turbowg/TurboTools for a complete list.

################################################################################

Extract the main TurboTools Git repository to your local system:
----------------------------------------------------------------
cd $HOME   # Or whichever working directory of your choice
# For read access only:
git clone git://git.code.sf.net/p/turbowg/TurboTools
# For read and write access (where <user_name> is your SourceForge user name):
git clone ssh://<user_name>@git.code.sf.net/p/turbowg/TurboTools

################################################################################

Checkout the TurboTools collection for (e.g.) ESI-OpenFOAM-v2412:
-----------------------------------------------------------------
cd $HOME/TurboTools
git checkout --track origin/ESI-OpenFOAM-v2412

################################################################################

Create a branch (here named <new_branch>) for a new version
(requires write access)
-----------------------------------------------------------
cd $HOME/TurboTools
git branch <new_branch>
git checkout <new_branch>
git push --set-upstream origin <new_branch>