Dynamic conformal metamaterials

Simulations for dynamic conformal metamaterials

Installation

Assuming you have access to the repo and ssh keys are set up in your GitHub account, you can install the package with

pip install git+ssh://git@github.com/bertoldi-collab/dynamic-conformal-metamaterials.git@main

First steps

You can find supporting data at Zenodo.

Dev notes

No experience with Python and/or git? Open this 👇

Go ahead with the following steps and you will learn along the way.

• Install git and learn a bit about it.
• If you don't have a favorite IDE yet, install vscode (this is just an environment that helps you writing code as well as managing git repositories).
• Install Python (any version above 3.7 should work fine).
• Follow the rest of the installation instructions below.

Installation (with poetry)

The dependency management of the project is done via poetry.

To get started

• Install poetry
• Clone the repo
• cd into the root directory and run poetry install. This will create the poetry environment.
• If you are using vscode, search for venv path in the settings and paste ~/.cache/pypoetry/virtualenvs in the venv path field. Then select the poetry enviroment as python enviroment for the project.

Installation (with pip)

This is meant to be a quick way to use the package. It is not recommended to use this method for development.

To get started

• Clone the repo
• cd into the root directory and run pip install -e .