Description of item

• Diligently commenting TT-ICE library
• Creating appropriate docstring tags for automated documentation

Correspondence: @dorukaks

Note to the creator: please name the branch according to <branch_type>/<your_name>/<issue_number(s)_that_you_address>
If you address more than 1 issue with one branch, write each number with an underscore like the following: "chore/doruk/1_2"
But don't try to adress too many issues with a single branch!

Create a PR template for descriptive PRs suggesting a repository structure

Description

This Bug should be fixed before any future merging into Main

Correspondence: @sahilbhola14
Branch (if applicable): #24

Steps to reproduce issue

Flake defaults to max line width of 80, while Black defaults to 120.
This contradicts pre-commit configuration

Current behavior

pre-commit fails for line width > 80 (Flakefails) while Black tries to reformat to 120 line-width format.

…

Expected behavior

Both Flake and Black should have consistent linewidth
…

Description of feature

So far, the documentation is being done locally for which scripts are already available.
Is it possible to automate the doc build state using git actions?

Correspondence: @dorukaks

Potential solution

Git actions

Description of item

Begin development of LSTM by coding and testing the one from this tutorial using TensorFlow.

Correspondence:
@camckenn

Note to the creator: please name the branch according to <branch_type>/<your_name>/<issue_number(s)_that_you_address>
If you address more than 1 issue with one branch, write each number with an underscore like the following: "chore/doruk/1_2"
But don't try to adress too many issues with a single branch!

Description of item

• Modify existing TT-ICE package to follow good software practices
• Remove unnecessary functions from library
• Create a utilities file and move appropriate functions to utilities file

Correspondence: @dorukaks

Note to the creator: please name the branch according to <branch_type>/<your_name>/<issue_number(s)_that_you_address>
If you address more than 1 issue with one branch, write each number with an underscore like the following: "chore/doruk/1_2"
But don't try to adress too many issues with a single branch!

Description of item

OpenFOAM directly provides post-processing through the command line. Post-processing can be done in the conventional manner (after all the data is generated) or run-time post-processing may be done. time, vorticity, turbulence (etc), velocity, will all be quantities that we want to consider and store.

Correspondence: @cfkawa

Note to the creator: please name the branch according to <branch_type>/<your_name>/<issue_number(s)_that_you_address>
If you address more than 1 issue with one branch, write each number with an underscore like the following: "chore/doruk/1_2"
But don't try to adress too many issues with a single branch!

We will follow some unified practices during this project. Therefore there will be some standards.
I will create a folder for reference. @sahilbhola14 once I'm done with it, it'd be great if you can chime in to polish some details.

Description of item

Creating support for GPU computation using CuPy package. This includes:

• Modify functions to have CuPy options
• Create new functions for CuPy support (if necessary)

Correspondence: @dorukaks

Note to the creator: please name the branch according to <branch_type>/<your_name>/<issue_number(s)_that_you_address>
If you address more than 1 issue with one branch, write each number with an underscore like the following: "chore/doruk/1_2"
But don't try to adress too many issues with a single branch!

Description of item

A dataset will be generated using OPENFOAM or XRAGE depending on time of release. Using XRAGE initial amplitude and phase of a 10 mode pertubation will be altered to examine the impact of the evolution of the instability growth. All together that is 20 parameters for each run. Each run evolves over 40ns time period. Data is output as snapshots of the material and density file at each time step. In the unfortunate event that we cannot get a release for the data, we will use the JAG ICF data developed by Lawarence Livermore National Lab in collaboration with UCSD.

Correspondence: @cfkawa

Note to the creator: please name the branch according to <branch_type>/<your_name>/<issue_number(s)_that_you_address>
If you address more than 1 issue with one branch, write each number with an underscore like the following: "chore/doruk/1_2"
But don't try to adress too many issues with a single branch!

Description

Format files are failing the pre-commits
Correspondence: @sahilbhola14
Branch (if applicable):

Steps to reproduce issue

Commit the changes to the repository and the pre-commit will fail

Current behavior

The format files have necessary white spaces, needs to be trimmed

Expected behavior

Pass the pre-commits

Description of item

• (refactor): Update snake_case to camelCase
• (refactor) : Add docstrings
• (docs): Update docs on Sphinx

Correspondence: @sahilbhola14

Description

Self explanatory title. Black wants to have white space before and after colon ":" but flake8 raises E203 error in that case.

Correspondence: @dorukaks
Branch (if applicable): main

Steps to reproduce issue

Running pre-commit run --all-files when there is a colon in any of the python scripts

Current behavior

flake8 raises E203 error when black fixes a file for colon whitespace

Expected behavior

flake8 shouldn't raise an error to the files fixed by black

Code versions

• Operating System:
• Python: N/A
• NumPy: N/A
• This repository: bf3de83

Description of feature

We need to set up automated tools (preferably pre-commit) to ensure uniform formatting throughout the entire repository

Correspondence: @sahilbhola14 @dorukaks

Potential solution

-No idea, we can look into git hooks maybe?

Note to the addressee: please name the branch according to <branch_type>/<your_name>/<issue_number(s)_that_you_address>
If you address more than 1 issue with one branch, write each number with an underscore like the following: "chore/doruk/1_2"

Description of item

Create minimal educational working examples for TT-ICE package using ATARI game snapshots

• TT-ICE
• TT-ICE*

Correspondence: @dorukaks

Note to the creator: please name the branch according to <branch_type>/<your_name>/<issue_number(s)_that_you_address>
If you address more than 1 issue with one branch, write each number with an underscore like the following: "chore/doruk/1_2"
But don't try to adress too many issues with a single branch!

Description

Sphinx configuration is missing for auto-doc.

Correspondence: @sahilbhola14
Branch (if applicable): #18

Steps to reproduce issue

create_documentation.sh will given error when generating the documentation

Current behavior

Missing configuration
…

Expected behavior

docs folder should be present
…

Description of item

• Transfer TT-ICE and TT-ICE* code to this repository as a major development branch
• Create draft PR into main for TT-ICE major development branch

Correspondence: @dorukaks

Note to the creator: please name the branch according to <branch_type>/<your_name>/<issue_number(s)_that_you_address>
If you address more than 1 issue with one branch, write each number with an underscore like the following: "chore/doruk/1_2"
But don't try to adress too many issues with a single branch!

Create issue template for descriptive issues in the repository

Description of item

After the completion of Issues #8, #14, and #15, develop LSTM which inherits data from TT-ICE to produce a surrogate forward model for the data.

Correspondence:
@camckenn

Note to the creator: please name the branch according to <branch_type>/<your_name>/<issue_number(s)_that_you_address>
If you address more than 1 issue with one branch, write each number with an underscore like the following: "chore/doruk/1_2"
But don't try to adress too many issues with a single branch!

Description of feature

Prepare the infrastructure for automated documentation generation.

Correspondence: @sahilbhola14 @dorukaks

Potential solution

• We can look into Doxygen (since it supports python and C++)

Note to the addressee: please name the branch according to <branch_type>/<your_name>/<issue_number(s)_that_you_address>
If you address more than 1 issue with one branch, write each number with an underscore like the following: "chore/doruk/1_2"

Description of feature

Create Git actions for linting and code verification

Correspondence: @sahilbhola14