Install PYLEECAN

Step 1: Getting the code

Welcome to the PYLEECAN installation page. As PYLEECAN is not (yet) available on pip, to use PYLEECAN, the first step is to get the code from Github:

_images/github_get_code.PNG

There are three ways of getting the code:

The “quick and dirty” way: Although we don’t recommend it, you can download an archive of the code by clicking on the green button “Clone or download” then “Download Zip” (orange square on the image). Nothing else to install, you can directly go to step 2.

The “I want to use it” way: For this method you will first need to install git or github. For Windows users, you may also want to install Tortoisegit (or any equivalent) for a more convenient use of git. Once git is installed you can “clone” the repository (either though command line or the tool you have installed with git) with the following command (green square on the image):

git clone https://github.com/Eomys/pyleecan

This method will enable you to get the upcoming modifications of the Pyleecan’s code in a more convenient way.

The “I want to contribute” way: You will need a Github account to fork (bleu square on the image) the pyleecan repository which will create a copy of the repository in your Github projects. The forked repository will allow you to freely experiment with changes without affecting the original project. Later you will be able to send modifications from your fork to the main project on Github with code.contribution:”pull-request”. You can now clone the forked version of Pyleecan in your Github projects but following the “I want to use it” way above. You can also click on “Watch” (red square on the image) to choose how you want to be notified of the activities of the community. As a reminder, before contributing, please read the project.organization:Project organization and the development:Development guidelines.

Step 2: Getting python and the dependencies

Now to be able to use the code you will need to download Python. We recommend a version >3.6 to be able to use black but this is not mandatory. Support with older Python version haven’t been checked and can be possible. If you experience difficulties with running Pyleecan with any version of Python, please open an issue on Github to talk about it.

Now that python is installed, you can download all the packages that are required to use pyleecan. All of them are gathered in the file requirements.txt. You can install them with one single command with pip (which should have been installed with python):

pip install -r requirements.txt

The principal of Pyleecan is to enable the user to choose between several model to compute the same quantities. Some of them call other software that you need to install as well (if you plan to use them). For now, the following software have a coupling with pyleecan: