> For the complete documentation index, see [llms.txt](https://anufrievroman.gitbook.io/freepaths/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://anufrievroman.gitbook.io/freepaths/getting-started/installation.md). # Installation FreePATHS requires Python 3. On Linux and MacOS, it is probably already installed. On Windows, you may choose to install [Anaconda](https://www.anaconda.com) package, which will install everything for you. Install the package from PyPi repository by entering this command into a terminal or a python console: ``` pipx install freepaths ``` ### Development If you'd like to work on the code, and run it without installing into your python folders, download the repository: ``` git clone https://github.com/anufrievroman/freepaths ``` Change your terminal directory to the directory of the repository (it's where the README file is): ``` cd freepaths ``` Run *FreePATHS* as: ``` python -m freepaths ``` This will run the code located inside the `freepaths` folder (which is inside the downloaded `freepaths` folder). In this case, the folder `freepaths` is considered a Python module.\ \ In case of troubles, make sure to uninstall all other copies of `freepaths` from your system, for example those installed with `pipx`: ``` pipx uninstall freepaths ``` ### Troubleshooting * If during installation, the terminal says something like `pipx is not found` that means you need to [install pip in your system](https://pipx.pypa.io/latest/installation/). * If after installation the program does not run and the error says something like `freepaths is not a recognised command` or `freepaths is not found`, but the `freepaths` package was actually installed, try running everything with `python -m` prefix, for example: `python -m freepaths`. This error occurs when the system can't find a path to installed packages, so you may need to restart the terminal or change `PATH` variable. * If installation fails, you can simply download this repository, start the terminal in its main directory (where the license file is) and run the program as `python -m freepaths`. In this case, you'll always need to run the program from this folder and place your input files there. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://anufrievroman.gitbook.io/freepaths/getting-started/installation.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.