Skip to content

Update development installation instructions #736

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 1 addition & 85 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,85 +1 @@
## Contributing

### Development install

**Note:** You will need [Node.js](https://nodejs.org/) and [Docker](https://www.docker.com/) to build the extension package.

The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.

```bash
# Clone the repo to your local environment
git clone https://github.com/jupytercad/JupyterCAD.git
# Change directory to the jupytercad directory
cd JupyterCAD
# Install JupyterLab for jlpm
pip install jupyterlab
# Install package in development mode
jlpm dev
# Rebuild extension Typescript source after making changes
jlpm run build
```

**Note:** You need to have docker installed to build `@jupytercad/opencascade` package, you can skip this step and download a prebuilt version by calling `jlpm dev --no-occ-build` instead of `jlpm dev`.

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab
```

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

```bash
jupyter lab build --minimize=False
```

### Custom Open Cascade WASM build

JupyterCAD uses a custom build of Open Cascade WASM. For performance and data usage concern, we only build the symbols we need.

This custom build is done in the `packages/opencascade` directory:

```bash
cd packages/opencascade
```

In order to rebuild it yourself, you need to install Docker, then you need to run the following (this may take some time):

```bash
yarn run build
```

In the case where you need to add new symbols, you can rebuild Open Cascade with the following command.

```bash
yarn run build --add symbol_to_add another_symbol ...
```

#### See also

Custom build doc: https://ocjs.org/docs/app-dev-workflow/custom-builds

Custom build example: https://github.com/donalffons/opencascade.js/blob/master/website/ocjs-editor-theme/src/customBuild/customBuild.yml

Where to find symbols: https://dev.opencascade.org/doc/refman/html/annotated.html

### Development uninstall

```bash
pip uninstall jupytercad
```

In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `jupytercad` within that folder.

### Packaging the extension

See [RELEASE](RELEASE.md)
Please check out [our documentation's contributing guide](https://jupytercad.readthedocs.io/en/latest/contributing.html).
30 changes: 22 additions & 8 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,39 @@ Contributing
Development install
-------------------

**Note:** You will need :ref:`Node.js <https://nodejs.org/>` and :ref:`Docker <https://www.docker.com/>` to build the extension package.
You need to create a development environment with `nodejs` and `jupyterlab` installed. We are here proposing to use `micromamba`.

The ``jlpm`` command is JupyterLab's pinned version of
:ref:`yarn <https://yarnpkg.com/>` that is installed with JupyterLab. You may use
:ref:`yarn <https://yarnpkg.com/>` or :ref:`npm <https://www.npmjs.com/>` in lieu of ``jlpm`` below.
.. code-block:: bash

# Create an environment with micromamba and install nodejs and jupyterlab
micromamba create -n jupytercad_dev -c conda-forge nodejs jupyterlab -y

You then need to clone the repository, proceed to installation and rebuild the extension.

.. code-block:: bash

# Clone the repo to your local environment
git clone https://github.com/jupytercad/JupyterCAD.git
# Change directory to the jupytercad directory
cd JupyterCAD
# Install JupyterLab for jlpm
pip install jupyterlab
# Install package in development mode
python scripts/dev-install.py
# Install dependencies and the package in development mode
jlpm install
jlpm dev ## if you haven't Docker installed replace this line by `jlpm dev --no-occ-build`
# Rebuild extension Typescript source after making changes
jlpm run build

**Note:** There are 2 possibilities for the installation.

1) either you are using [Docker](https://www.docker.com/) to build `@jupytercad/opencascade` package and you need to run `jlpm dev` in the commands above.

2) or you are using a prebuilt version by calling `jlpm dev --no-occ-build` to install the package.


**Note:** The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` above.


You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

.. code-block:: bash
Expand Down
Loading