Skip to content
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

Roadmap Documentation Page #1231

Merged
merged 2 commits into from
Jul 14, 2020
Merged

Roadmap Documentation Page #1231

merged 2 commits into from
Jul 14, 2020

Conversation

marxwillia
Copy link
Contributor

Description

I have added a Roadmap documentation page under our contributor guidelines.

Motivation and Context

We want to keep track of the ongoing developement on TARDIS as well as document it for interested users and new developers.

How Has This Been Tested?

Built the docs locally and all seems fine.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have assigned/requested two reviewers for this pull request.

@codecov
Copy link

codecov bot commented Jul 13, 2020

Codecov Report

Merging #1231 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1231   +/-   ##
=======================================
  Coverage   80.63%   80.63%           
=======================================
  Files          41       41           
  Lines        3423     3423           
=======================================
  Hits         2760     2760           
  Misses        663      663           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2599b0c...c77a731. Read the comment docs.

@wkerzendorf wkerzendorf merged commit 6095cea into tardis-sn:master Jul 14, 2020
- Deposited energy needs to be thermalized by solving the Spencer-Fano
equations, resulting in fractions of the energy going into heating,
non-thermal excitation and non-thermal ionization.
- At late times when the densities are low collisions become too
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low, collisions

of the code. However, this requires significant code overhead and is difficult
to maintain given that many of our developers are junior researchers who may
be less familiar with C code.
- As one of TARDIS’ key focuses is its use as an educational tool, we would like
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part of TARDIS’ mission is to be an educational tool for researchers and developers at all levels. This project aims to minimize the complexity of the code so that it can be understood by a wider audience.

Copy link
Contributor

@ycamacho ycamacho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with 2 minor suggestions.

Copy link
Member

@jaladh-singhal jaladh-singhal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I'm late it's merged now - I forgot to submit my review.

- We are currently in the process of converting this Cython and C code to Numba,
which we hope will allow us to maintain the performance of Cython but with code
that is now exclusively written in (numba-fied) Python.
* GPU (Spring 20201)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* GPU (Spring 20201)
* GPU (Spring 2021)

@jaladh-singhal
Copy link
Member

@wkerzendorf can we revert it?

ebjordi pushed a commit to ebjordi/tardis that referenced this pull request Jul 17, 2020
* Added roadmap link to main page

* Added roadmap page

Co-authored-by: Marc Williamson <[email protected]>
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* Added roadmap link to main page

* Added roadmap page

Co-authored-by: Marc Williamson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants