Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Working Scilpy development container for VS Code #733

Merged
merged 4 commits into from
Aug 18, 2023

Conversation

AlexVCaron
Copy link
Collaborator

@AlexVCaron AlexVCaron commented Aug 15, 2023

PR adding to the repository the necessary files to enable the creation of a development container in VS Code. Once merged, users will be able to automatically create a development environment through VS Code, that contains the whole Scilus development stack (ANTs, FSL, Mrtrix, etc.), and develop Scilpy in it.

In addition to VS Code, this requires Docker, to create the development container - spawning the containers takes a few minutes (depending on the user's internet speed). The containers comes pre-equiped with Git and several VS Code extensions to streamline development, and is connected to docker outside the container (so it can build images as well).

Once created, VS Code opens an IDE inside the container, where Scilpy is installed. The user can then develop Scilpy, interact with repositories through Git, run tests inside the container and modify its content (the user has read/write permissions), and much more.

As of now, the only binding between the local machine and the container is through the Scilpy repository directory. We could consider adding other bindings, but this needs a bit of research.

Marche-à-suivre to test the container creation :

  • Launch VS Code and open your workspace in the Scilpy repository directory
  • In the extensions market (in the left menu strip), install the Dev Containers extension
  • Click on the blue button in the lower left corner to open the Remoting menu
  • Select Reopen in container

@AlexVCaron
Copy link
Collaborator Author

@arnaudbore @frheault This does not really need review, but I think this will interest you both. Could be really nice for onboarding and creating dev setups for projects/internships/homeworks

@arnaudbore
Copy link
Contributor

Build passed ! Good Job 🍻 !

2 similar comments
@arnaudbore
Copy link
Contributor

Build passed ! Good Job 🍻 !

@arnaudbore
Copy link
Contributor

Build passed ! Good Job 🍻 !

@arnaudbore
Copy link
Contributor

Can you write some instructions about this in scilpy readthedoc ?

@arnaudbore
Copy link
Contributor

Build passed ! Good Job 🍻 !

1 similar comment
@arnaudbore
Copy link
Contributor

Build passed ! Good Job 🍻 !

@arnaudbore arnaudbore merged commit f6c8602 into scilus:master Aug 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants