Skip to content
Bjoern Ludwig edited this page Sep 17, 2019 · 34 revisions

Welcome to the Met4FoF code wiki!

Met4FoF logo

Introduction

Here you will be provided additional information around code writing and development in the EMPIR project 17IND12 Met4FoF.

On the following pages you will find step by step instructions for a quick start working with the project's code and useful links to help you on your way with Git and other mandatory tools for the software development in the project.

Step-by-step guide

We start with the installation of the mandatory tools and then install and configure recommended tools to work with the code.

Install Git

The installation of Git for all platforms is very well described here.

Create local copy of the repository

Once Git is installed, you are ready to create a local copy of the repository and take a first glance at the code.

Install Miniconda

We need a current Python distribution and use Miniconda, a slimmed down version of Anaconda in this guide, to create a flexible and updatable runtime environment for Python.

There are excellent installation instructions in the official docs.

In case you already have a current Python implementation running you could skip this step.

Create virtual environment

We then create a virtual environment with Miniconda to provide the currently needed packages of our project code. Detailed instructions and explanations you find on this wiki page.

Ready for CLI executions

On the command line we can then execute all parts of the project code and of yourse could use any tool we are used to for further development.

Prepare an IDE

To work on the code, we recommend installing the IDE PyCharm Community Edition, because it offers an excellent integration of virtual environments (of any kind) and comes with the most advanced coding tools.

Install PyCharm

Finally, we show you how to install and set up PyCharm.

Useful links

Checkout our Git glossary to get insights in the Git vocabulary.