From 534936ca58f119ed89b370aace46b2b00be2e75e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9rome=20Eertmans?= Date: Wed, 29 May 2024 14:42:45 +0200 Subject: [PATCH] chore(paper): first draft --- .github/workflows/draft-joss-paper.yml | 34 ++++++++++++++ .pre-commit-config.yaml | 5 +++ README.md | 5 ++- papers/eucap2024/README.md | 6 +++ {paper => papers/eucap2024}/__init__.py | 0 .../eucap2024}/plot_optimize_steps.py | 0 {paper => papers/eucap2024}/plot_power_map.py | 0 .../eucap2024}/plot_zero_gradient.py | 0 {paper => papers/eucap2024}/utils.py | 0 papers/joss/paper.bib | 0 papers/joss/paper.md | 45 +++++++++++++++++++ 11 files changed, 94 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/draft-joss-paper.yml create mode 100644 papers/eucap2024/README.md rename {paper => papers/eucap2024}/__init__.py (100%) rename {paper => papers/eucap2024}/plot_optimize_steps.py (100%) rename {paper => papers/eucap2024}/plot_power_map.py (100%) rename {paper => papers/eucap2024}/plot_zero_gradient.py (100%) rename {paper => papers/eucap2024}/utils.py (100%) create mode 100644 papers/joss/paper.bib create mode 100644 papers/joss/paper.md diff --git a/.github/workflows/draft-joss-paper.yml b/.github/workflows/draft-joss-paper.yml new file mode 100644 index 0000000..0c188d6 --- /dev/null +++ b/.github/workflows/draft-joss-paper.yml @@ -0,0 +1,34 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Create JOSS Paper + +on: + # Runs on pushes targeting the default branch + push: + paths: + - papers/joss/* + - .github/workflows/draft-joss-paper.yml + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +jobs: + paper: + runs-on: ubuntu-latest + name: Paper Draft + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Build draft PDF + uses: openjournals/openjournals-draft-action@master + with: + journal: joss + # This should be the path to the paper within your repo. + paper-path: papers/joss/paper.md + - name: Upload + uses: actions/upload-artifact@v4 + with: + name: paper + # This is the output path where Pandoc will write the compiled + # PDF. Note, this should be the same directory as the input + # paper.md + path: papers/joss/paper.pdf diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e6aba66..28c15ac 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -32,3 +32,8 @@ repos: - id: codespell additional_dependencies: - tomli +- repo: https://github.com/FlamingTempura/bibtex-tidy + rev: v1.9.0 # DO NOT CHANGE, see https://github.com/FlamingTempura/bibtex-tidy/issues/419 + hooks: + - id: bibtex-tidy + args: [--no-backup, --sort, --sort-fields] diff --git a/README.md b/README.md index 1bbc04c..a185911 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ [![Latest Release][pypi-version-badge]][pypi-version-url] [![Python version][pypi-python-version-badge]][pypi-version-url] [![Documentation][documentation-badge]][documentation-url] -[![codecov][codecov-badge]][codecov-url] +[![DOI][doi-badge]][doi-url] +[![Codecov][codecov-badge]][codecov-url] Differentiable Ray Tracing (RT) Python framework for Telecommunications-oriented applications. @@ -132,5 +133,7 @@ you can do so at: [jeertmans@icloud.com](mailto:jeertmans@icloud.com). [pypi-python-version-badge]: https://img.shields.io/pypi/pyversions/DiffeRT2d [documentation-badge]: https://img.shields.io/website?down_color=lightgrey&down_message=offline&label=documentation&up_color=green&up_message=online&url=https%3A%2F%2Feertmans.be%2FDiffeRT2d%2F [documentation-url]: https://eertmans.be/DiffeRT2d/ +[doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.11386517.svg +[doi-url]: https://doi.org/10.5281/zenodo.11386517 [codecov-badge]: https://codecov.io/gh/jeertmans/DiffeRT2d/branch/main/graph/badge.svg?token=1dJ1AKWMR5 [codecov-url]: https://codecov.io/gh/jeertmans/DiffeRT2d diff --git a/papers/eucap2024/README.md b/papers/eucap2024/README.md new file mode 100644 index 0000000..e91c8d0 --- /dev/null +++ b/papers/eucap2024/README.md @@ -0,0 +1,6 @@ +# EuCAP 2024 Paper + +This present folder contains the code that was used to generate +the figures in: +[*Fully Differentiable Ray Tracing via Discontinuity Smoothing for Radio Network Optimization*]( +https://doi.org/10.23919/EuCAP60739.2024.10501570). diff --git a/paper/__init__.py b/papers/eucap2024/__init__.py similarity index 100% rename from paper/__init__.py rename to papers/eucap2024/__init__.py diff --git a/paper/plot_optimize_steps.py b/papers/eucap2024/plot_optimize_steps.py similarity index 100% rename from paper/plot_optimize_steps.py rename to papers/eucap2024/plot_optimize_steps.py diff --git a/paper/plot_power_map.py b/papers/eucap2024/plot_power_map.py similarity index 100% rename from paper/plot_power_map.py rename to papers/eucap2024/plot_power_map.py diff --git a/paper/plot_zero_gradient.py b/papers/eucap2024/plot_zero_gradient.py similarity index 100% rename from paper/plot_zero_gradient.py rename to papers/eucap2024/plot_zero_gradient.py diff --git a/paper/utils.py b/papers/eucap2024/utils.py similarity index 100% rename from paper/utils.py rename to papers/eucap2024/utils.py diff --git a/papers/joss/paper.bib b/papers/joss/paper.bib new file mode 100644 index 0000000..e69de29 diff --git a/papers/joss/paper.md b/papers/joss/paper.md new file mode 100644 index 0000000..8dc7e0f --- /dev/null +++ b/papers/joss/paper.md @@ -0,0 +1,45 @@ +--- +title: 'Manim Slides: A Python package for presenting Manim content anywhere' +tags: + - Python + - manim + - animations + - teaching + - conference presentations + - tool +authors: + - name: Jérome Eertmans + orcid: 0000-0002-5579-5360 + affiliation: 1 + - name: Claude Oestges + orcid: 0000-0002-0902-4565 + affiliation: 1 + - name: Laurent Jacques + orcid: 0000-0002-6261-0328 + affiliation: 1 +affiliations: + - name: ICTEAM, UCLouvain, Belgium + index: 1 +date: 2 March 2023 +bibliography: paper.bib +--- + +# Summary + +# Introduction + +# Easy to Use Commitment + +# Example usage + +# Stability and releases + +# Statement of Need + +## Target Audience + +## Comparison with similar tools + +# Acknowledgments + +# References