Skip to content

Feature Request: Include a Docker Setup for Easy Compilation #101

@nonameebyrator985

Description

@nonameebyrator985

Feature Request: Include a Docker Setup for Easy Compilation

Overview

Given the multiple compiler options and configurations described in the README, setting up the development environment can be complex for new users. To simplify the process and ensure consistency across different operating systems, I propose creating a Docker setup that allows for easy compilation of both the sa_mesh and mpi_sa_mesh targets.

Benefits

  • Consistency: Users can run the same environment regardless of their operating system, reducing issues related to dependencies or configurations.
  • Simplicity: New contributors can get started quickly without needing to install compilers or libraries manually.
  • Isolation: It provides a clean environment for different versions or configurations without affecting the host system.

Suggested Steps

  1. Create a Dockerfile that installs the necessary compilers (gfortran, ifort, OpenMPI) based on the user's selection.
  2. Provide a script to build the container and easily switch between different compilation targets.
  3. Update the README with instructions on how to use the Docker setup for building the project.

Additional Considerations

  • Include examples of building both serial and parallel versions within the Docker setup.
  • Ensure that the Docker container can be easily extended for users who may want to add additional libraries or dependencies in the future.

By implementing this feature, we can enhance the onboarding experience for new contributors and streamline the development process.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions