Skip to content

Commit

Permalink
chore(paper): first draft
Browse files Browse the repository at this point in the history
  • Loading branch information
jeertmans committed May 29, 2024
1 parent fdcfd10 commit 534936c
Show file tree
Hide file tree
Showing 11 changed files with 94 additions and 1 deletion.
34 changes: 34 additions & 0 deletions .github/workflows/draft-joss-paper.yml
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
6 changes: 6 additions & 0 deletions papers/eucap2024/README.md
Original file line number Diff line number Diff line change
@@ -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).
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Empty file added papers/joss/paper.bib
Empty file.
45 changes: 45 additions & 0 deletions papers/joss/paper.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 534936c

Please sign in to comment.