Installation#
You can install Tcplotter using pip.
pip install tcplotter
Note: In order for Tcplotter to work properly you will also need to install the thermochronometer age prediction programs available in the Tccore package.
Installing the latest version of Tcplotter from GitHub (not recommended)#
Below you will find the steps to install the latest version of the Tcplotter package from GitHub. If you have difficulty with the installation, we recommend using Binder to create and save plots using Tcplotter.
First, you will need the several items in order to compile the software used for thermochronometer age and closure temperature calculations.
a compatible C compiler
a compatible C++ compiler
You can find more information about which compilers can be used with cmake from the cmake documentation page.
In addition, Tcplotter requires Python >= 3.10 with the following Python libraries:
numpymatplotlib-basescipy
Once the required Python libraries have been installed, you can download the Tcplotter code from GitHub by visiting the Tcplotter GitHub page, clicking on the Code button on the upper right side of the page, and selecting Download ZIP. After the download completes, you can extract the files using your preferred software.
At this point, you will need to compile the software for calculating the thermochronometer ages using cmake. You can find instructions about how to do this on the Tccore package GitHub page.
You can now do a local install of Tcplotter using
pipby navigating to the basttcplotterdirectory in a terminal and running the following:pip install -e .
This will install Tcplotter locally for your use.
Testing the installation#
At this point you should have a working Tcplotter installation. You can test it by running on of the Tcplotter command-line programs. For example, you could run the following in a terminal where Tcplotter is installed:
eu-vs-radius
This should produce a contour plot of cooling ages and closure temperatures for a range of effective uranium and grain radius values.
Optional graphical progress bar#
It is possible to enable a graphical progress bar with tcplotter when using it in a Jupyter notebook. This requires the ipywidgets library. ipywidgets can also be installed using pip or conda:
pip install ipywidgets
or
conda install -c conda-forge ipywidgets