How to install CatSim Python package - xcist/documentation GitHub Wiki

Option 1: Install by "pip install" command (directly from PyPI server)

In your Python command line window or console, run

pip install gecatsim

This will install from the PyPI server - https://pypi.org/project/gecatsim/

Note: If you are installing this while behind a company firewall, you might need to specify your company proxy information to the pip command using the "--proxy" option, e.g., pip --proxy http://your-company-proxy-info install gecatsim. Ask your IT for your proxy information.

Option 2 (for developers): Get source code from GitHub.com

(Supported OS: Windows 7 and Windows 10 64-bit; Linux 64-bit, Mac OS 13.5).

1. Set up Git (skip if you already have Git)

2. Clone CatSim repository. In you Git command window:

git clone https://github.com/xcist/main.git

Or if you're unfamiliar with git, you might find the GitHub Desktop helpful.

3. Install CatSim package.

In a Python command window, navigate to the CatSim main directory and type:

pip install . --use-feature=in-tree-build

If you don't have administrator rights on the account, you can try:

pip install . --user --use-feature=in-tree-build