Installation Guide

Note: this installation process has been tested on

  • windows / amd64 platform

To install CodPy, you can use pip:

pip install codpy

Alternatively, if you are installing from source:

git clone https://github.com/codpy2020/codpy
cd codpy
pip install .

Requirements

Make sure to have these installed before proceeding.

NOTE : Python installations differ from one machine to another. The python root folder is denoted “<path/to/python39>” in the rest of this document. The software Everything, or other finding files tools can be useful locating the file python.exe on windows machine…

Dev installation

For information, we list the softwares that we are using for our dev configuration :

Those installations should be fine using the latest (64 bits) version and the default settings for each software .

Note Once R and RStudio are installed, open the latter. In the console, enter “install.packages(“rmarkdown”)” to install RMarkdown.

Installation procedure

We suppose that there is a valid python installation on the host machine. The reader can * either use its main python environment <path/to/python39> * or create a virtual python environment <path/to/venv>, generally an advisable practice:

First open a command shell cmd, create a virtual environment and activate it using the commands

python -m venv .\venv
.\venv\Scripts\activate

NOTE : In the rest of the installation procedure, we consider a virtual environment <path/to/venv>. One can replace with <path/to/python39> if a main environment installation is desired, for dev purposes for instance.

Open a command shell `cmd`, and pip install codpy

pip install codpy==0.XX.XX

or from a local repository

pip install <path/to/codpyrepo>/dist/codpy-XXXX.whl

The installation procedure might take some minutes depending on your internet connection.

Basic checking

open a python shell and import codpy

python
import codpy

It should run silently.