ansys / ansys/pyansys-workflows

Please update the examples to use Jupytext

Open
#61 9 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
14
Forks
6
Avg merge
2h 55m
Merged PRs (30d)
13

Description

### 📝 Description of the feature

[Jupytext](https://jupytext.readthedocs.io/en/latest/) allows publication
of Jupyter Notebooks in pure Python. It is much easier for users to modify/update and document examples since they can edit and modify the examples in an
WYSIWYG environment.

### 💡 Steps for implementing the feature

Update the GitHub Actions and dependencies to support Jupytext. Use the PyAEDT examples
[workflow](https://github.com/ansys/pyaedt-examples/blob/main/.github/workflows/ci_cd.yml)
and [dependencies](https://github.com/ansys/pyaedt-examples/blob/main/requirements/requirements_doc.txt)
as a reference.

### 🔗 Useful links and references

See the [PyAEDT](https://github.com/ansys/pyaedt-examples) Examples repository.

Contributor guide

Open the contributing guide

Research direction

Inspect this repository’s GitHub Actions and dependency files, using the linked PyAEDT examples .github/workflows/ci_cd.yml and requirements/requirements_doc.txt as references. Determine how the examples are currently built and published, then update the workflow and dependencies so Jupytext is supported and verify the example publication process completes successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, jupyter-notebook, python
Domain
build-system, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.