Installation

Download an IDE

We recommend using Visual Studio Code

Confirm python is installed

In the command line or termainal run

python --version

This should output the current version of python if installed. E.g., Python 3.10.9 To download python visit python.org/downloads.

Confirm git is installed

Most Mac or linux systems come with git pre-installed. To confirm if git is installed run the following in the command line on Windows or terminal on Mac:

git --version

This should output the current version of git if installed. E.g., git version 2.39.2 To download git visit git-scm.com/downloads.

Configure virtual environment

Although no virtual environment is required to install mecode, it is highly recommended to avoid dependency issues when working with multiple python packages.

CondaMamba

Install latest version of miniconda.

Note

If prompted to add conda to path, the answer is almost always yes. If you're not sure, check yes to avoid conda not found issues down the road.

Create a new environment for working with mecode. E.g., to create a virtual environment 3dp

    conda create -n 3dp

Once created, activate the virtual environment

    conda activate 3dp

Using conda install pip and git

    conda install pip git

Install latest version of Mamba.

Create a new environment for working with mecode. E.g., to create a virtual environment 3dp

    mamba create -n 3dp

Once created, activate the virtual environment

    mamba activate 3dp

Using mamba install pip and git

    mamba install pip git

Installing mecode

GitHubPyPiConda-Forge

    pip install git+https://github.com/rtellez700/mecode.git

If you currently have an old version of mecode, use the following instead:

    pip install git+https://github.com/rtellez700/mecode.git --upgrade --force-reinstall

When a new version is available you can re-run the previous command.

In-progress

In-progress

Open up Visual Studio Code to start you first mecode script. Run code . in the command line / terminal to open VS code for the current directory. Otherwise, open VS Code and choose the appropriate project folder. For more information on how to use VS Code please check out their documentation at https://code.visualstudio.com/learn