MIT-LAE / APCEMM

Aircraft Plume Chemistry, Emissions, and Microphysics Model
MIT License
9 stars 17 forks source link

Feature/docker devcontainer #4

Closed ddrake-mitre closed 1 year ago

ddrake-mitre commented 1 year ago

Title: Add Dockerfile for Dependencies and DevContainer for VSCode

Description:

This pull request adds a new Dockerfile and DevContainer configuration for easier development using Visual Studio Code, as well as providing instructions for installing necessary dependencies on a physical machine. By using Docker and the Remote-Containers extension, contributors can quickly set up a consistent development environment with all the required dependencies pre-installed.

Changes:

How to test:

  1. Install the Remote-Containers extension in Visual Studio Code.
  2. Install Docker on your machine following the official documentation: Docker Installation
  3. Set up DevContainers in Visual Studio Code by following the official documentation: DevContainers Setup
  4. Clone the repository and open it in VSCode.
  5. When prompted, choose to "Reopen in Container" or open the Command Palette (Ctrl+Shift+P) and select "Remote-Containers: Reopen in Container".
  6. Wait for the container to build and the dependencies to be installed.
  7. Once the environment is set up, you can start developing and testing changes within the container.
  8. To test that the DevContainer is built correctly, run the example script located at ./examples/Example1_EPM/run_example1.sh. If the script runs successfully, everything is working correctly.

For local development on a physical machine, follow the instructions in the Dockerfile to install the necessary dependencies.

I cloned, built, and ran this all on my personal machine, in addition to my MITRE laptop.