Skip to content

Commit 37b5e3b

Browse files
committed
update documentation for using contributing environment
1 parent 3da1847 commit 37b5e3b

File tree

1 file changed

+43
-1
lines changed

1 file changed

+43
-1
lines changed

docs/contributors.rst

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ update an existing environment, as necessary.
99

1010
Development in Docker is encouraged, for the sake of consistency and
1111
portability.
12-
By default, work should be built off of `poldracklab/fmriprep:latest
12+
By default, work should be built off of `poldracklab/fmriprep:unstable
1313
<https://hub.docker.com/r/poldracklab/fmriprep/>`_ (see the
1414
installation_ guide for the basic procedure for running).
1515

@@ -130,6 +130,48 @@ This image may be accessed by the `fmriprep-docker`_ wrapper via the
130130

131131
$ fmriprep-docker -i fmriprep --shell
132132

133+
Code-Server Development Environment (Experimental)
134+
==================================================
135+
To get the best of working with containers and having an interactive
136+
development environment, we have an experimental setup with `code-server
137+
<https://github.com/cdr/code-server>`_.
138+
139+
1. build the docker image
140+
~~~~~~~~~~~~~~~~~~~~~~~~~
141+
We will use the ``Dockerfile_devel`` file to build
142+
our development docker image::
143+
144+
$ cd $HOME/projects/fmriprep
145+
$ docker build -t fmriprep_devel -f Dockerfile_devel .
146+
147+
2. run the docker image
148+
~~~~~~~~~~~~~~~~~~~~~~~
149+
We can start a docker container using the image we built (``fmriprep_devel``)::
150+
151+
$ docker run -it -p 127.0.0.1:8445:8080 -v ${PWD}:/src/fmriprep fmriprep_devel:latest
152+
153+
If the container started correctly, you should see the following on your console::
154+
155+
INFO Server listening on http://localhost:8080
156+
INFO - No authentication
157+
INFO - Not serving HTTPS
158+
159+
Now you can switch to your favorite browser and go to: ``127.0.0.1:8445``.
160+
161+
Code-Server Development Environment Features
162+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
163+
164+
- The editor is `vscode <https://code.visualstudio.com/docs>`_
165+
166+
- There are several preconfigured debugging tests under
167+
the debugging icon in the activity bar
168+
169+
- see `vscode debugging python <https://code.visualstudio.com/docs/python/debugging>`_
170+
for details.
171+
172+
- The ``gitlens`` and ``python`` extensions are preinstalled to improve
173+
the development experience in vscode.
174+
133175

134176
Adding new features to the citation boilerplate
135177
===============================================

0 commit comments

Comments
 (0)