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.

Sign up for GitHub

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

Jump to bottom

Feat: GCBM Refactor Idea Draft #206

Open
wants to merge 25 commits into
base: master
Choose a base branch
from
Open

Feat: GCBM Refactor Idea Draft #206

wants to merge 25 commits into from

Conversation

Freeman-kuch
Copy link

@Freeman-kuch Freeman-kuch commented Oct 27, 2022 •
edited

Pull Request Template

Description

flint-UI has plans to separate the "/upload" endpoint into different endpoints depending on the category of config input. so endpoints like

  • "/gcbm/upload/disturbances"
  • "/gcbm/upload/classifiers"
  • "/gcbm/upload/miscellaneous"
  • "/gcbm/upload/db"
  • "/upload/title" (this sort of is likened to the "/create" endpoint which creates a new simulation and assigns a name to the simulation from user input)
  • A separate endpoint to Run the simulation would also be used instead of "/dynamic"(might get deprecated). The endpoint would just run the simulation after the necessary configs have been set

All these would be used instead of the all-purpose "/upload" and "/dynamic" endpoints

Fixes #205

Type of change

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

I tested these new features locally using Postman without a Docker container and successfully created a simulation and uploaded the different config files and variables(attributes)
@SanjaySinghRajpoot,
@Namyalg,
@HarshCasper ,
@aornugent ,
@Dabjazz.
...

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings
  • I have tagged the reviewers in a comment below incase my pull request is ready for a review
  • I have signed the commit message to agree to Developer Certificate of Origin (DCO) (to certify that you wrote or otherwise have the right to submit your contribution to the project.) by adding "--signoff" to my git commit command.

radistoubalidis and others added 20 commits October 28, 2022 00:57
@radistoubalidis @HarshCasper @Freeman-kuch
Enrich the CML Action using Jupytext (moja-global#176)
bddce12 
* reproduce FLINT.Cloud apis

* example sim report using cml

* Update cml-report.yml

* Update cml-report.yml

* Update cml-report.yml

* Update cml-report.yml

* test if cml is setup right

* add cml script

* changed file paths to not show local directories

* update cml report

* setup GCBM summary

* setup GCBM summary

* setup GCBM summary

* setup GCBM summary

* setup GCBM summary

* setup GCBM summary

* setup GCBM summary

* setup GCBM summary

* update python script

* run model summary

* add sim start and end dates

* delete irrelevant files

* convert annual_summaries.py to py:percent format

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* converts and run annual_summaries.py as notebook usinng jupytext

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (try 4)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (try 5)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (fixed typo on 5, try 6)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (fixed typo on 7)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (try 8)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (try 9)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (try 10)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (try 11)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (try 12)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* check why cml comment is 404 not found

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* uncomment labeling filter

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* adds --uptate option to cml send-comment command

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test cml action with --update

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test cml action with --update

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test action with GITHUB_SHA var

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test action with GITHUB_SHA var (fix typo)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test cml action without --pr option

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* run workflow only on labels

* reproduce FLINT.Cloud apis

* example sim report using cml

* Update cml-report.yml

* Update cml-report.yml

* Update cml-report.yml

* Update cml-report.yml

* test if cml is setup right

* add cml script

* changed file paths to not show local directories

* update cml report

* setup GCBM summary

* setup GCBM summary

* setup GCBM summary

* setup GCBM summary

* setup GCBM summary

* setup GCBM summary

* setup GCBM summary

* setup GCBM summary

* update python script

* run model summary

* add sim start and end dates

* delete irrelevant files

* convert annual_summaries.py to py:percent format

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* converts and run annual_summaries.py as notebook usinng jupytext

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (try 4)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (try 5)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (fixed typo on 5, try 6)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (fixed typo on 7)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (try 8)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (try 9)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (try 10)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (try 11)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test if action works with jupytext (try 12)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* check why cml comment is 404 not found

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* uncomment labeling filter

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* adds --uptate option to cml send-comment command

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test cml action with --update

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test cml action with --update

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test action with GITHUB_SHA var

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test action with GITHUB_SHA var (fix typo)

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* test cml action without --pr option

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>

* run workflow only on labels

* fix lint

Signed-off-by: radis toubalidis <rtoumpalidis@gmail.com>
Co-authored-by: HarshCasper <erbeusgriffincasper@gmail.com>
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@khanjasir90 @Freeman-kuch
chore: moved get_config_templates, get_modules_cbm_config, get_pr… (m…
65135c8 
…oja-global#181)

* refactor: moved get_config_templates, get_modules_cbm_config, get_provider_config to preprocess.py file

Signed-off-by: khanjasir90 <khanmohdjasir@gmail.com>

* app.py and preprocess.py linted

Signed-off-by: khanjasir90 <khanmohdjasir@gmail.com>

Signed-off-by: khanjasir90 <khanmohdjasir@gmail.com>
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@SanjaySinghRajpoot @Freeman-kuch
feat: added Furo theme, GCBM dev docs and Restructured deployments do…
9545161 
…cs (moja-global#164)

* feat: added fluro and GCBM dev docs

Signed-off-by: SanjaySinghRajpoot <iamsanjayrajpoot@gmail.com>

* chores: furo added to requirements

Signed-off-by: SanjaySinghRajpoot <iamsanjayrajpoot@gmail.com>

* chores: restructed Deployment docs

Signed-off-by: SanjaySinghRajpoot <iamsanjayrajpoot@gmail.com>

Signed-off-by: SanjaySinghRajpoot <iamsanjayrajpoot@gmail.com>
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@SanjaySinghRajpoot @Freeman-kuch
feat: autoapi implemented to document APIs (moja-global#173)
2a803b6 
* feat: autoapi implemented

* chore: autoapi added to requirements

Signed-off-by: SanjaySinghRajpoot <iamsanjayrajpoot@gmail.com>

* CI fix

Signed-off-by: SanjaySinghRajpoot <iamsanjayrajpoot@gmail.com>

Signed-off-by: SanjaySinghRajpoot <iamsanjayrajpoot@gmail.com>
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@Crystalsage @Namyalg @Freeman-kuch
docs: Add responses to the GCBM docs (moja-global#184)
e4d2e62 
docs: Add expected response codes on sucess to the GCBM docs

Adds response codes to the GCBM curl documentation. Also changes
the format of the document to be more navigable.

Signed-off-by: Amit <amitkulkarni2028@gmail.com>

Signed-off-by: Amit <amitkulkarni2028@gmail.com>
Co-authored-by: Namya LG <53875297+Namyalg@users.noreply.github.com>
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@khanjasir90 @Namyalg @Freeman-kuch
feat: added endpoint to return .json for the input .tiff file (moja-g…
7ecf76a 
…lobal#185)

* feat: added endpoint to return .json for the input .tiff file

Signed-off-by: khanjasir90 <khanmohdjasir@gmail.com>

* feat: updated endpoint with specified changes and some constraints

Signed-off-by: khanjasir90 <khanmohdjasir@gmail.com>

* feat: formatted code with black

Signed-off-by: khanjasir90 <khanmohdjasir@gmail.com>

* updated minor typos

Signed-off-by: khanjasir90 <khanmohdjasir@gmail.com>

Signed-off-by: khanjasir90 <khanmohdjasir@gmail.com>
Co-authored-by: Namya LG <53875297+Namyalg@users.noreply.github.com>
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@SanjaySinghRajpoot @Freeman-kuch
Updated curl cmds for the GCBM dynamic endpoints (moja-global#194)
61a459b 
* feat: updated curl cmds

Signed-off-by: SanjaySinghRajpoot <iamsanjayrajpoot@gmail.com>

* db added and doc formated

Signed-off-by: SanjaySinghRajpoot <iamsanjayrajpoot@gmail.com>

* example text fixed

Signed-off-by: SanjaySinghRajpoot <iamsanjayrajpoot@gmail.com>

Signed-off-by: SanjaySinghRajpoot <iamsanjayrajpoot@gmail.com>
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@temitayopelumi @Freeman-kuch
chore:removed /rothc endpoint description from swagger documentation …
bcf0c3f 
…of rest api gcbm (moja-global#195)

Signed-off-by: olalekan temitayo <olalekantemitayo7@gmail.com>

Signed-off-by: olalekan temitayo <olalekantemitayo7@gmail.com>
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@Saurabh-Suchak @HarshCasper @Freeman-kuch
Improved Documentation for GCBM REST API (moja-global#144)
420d80a 
* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* changed the endpoint name

* Update app.py

* Update README.md

Co-authored-by: Harsh Mishra <erbeusgriffincasper@gmail.com>
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@Freeman-kuch
GCBM Refactor idea Draft
6f843c6 
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@Freeman-kuch
GCBM Refactor idea Draft
8c24f84 
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@Freeman-kuch
GCBM Refactor idea Draft
9a9a9a1 
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@temitayopelumi @Freeman-kuch
fix: add a check to see if simulation output exists (moja-global#199)
bbdab43 
Signed-off-by: olalekan temitayo <olalekantemitayo7@gmail.com>

Signed-off-by: olalekan temitayo <olalekantemitayo7@gmail.com>
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@clintonMF @Freeman-kuch
docs: document the /gcbm/getConfig endpoint (moja-global#201)
1a6da28 
Signed-off-by: Clinton Mekwunye <mekwunyeclinton22@gmail.com>

Signed-off-by: Clinton Mekwunye <mekwunyeclinton22@gmail.com>
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@Freeman-kuch
GCBM Refactor idea Draft
cce284d 
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@Freeman-kuch
GCBM Refactor idea Draft
b93e518 
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@Freeman-kuch
GCBM Refactor idea Draft
0c6092c 
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@Freeman-kuch
GCBM Refactor idea Draft
0f6000c
@Freeman-kuch
GCBM Refactor idea Draft
674b919 
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@Freeman-kuch
GCBM Refactor idea Draft
3354a5c 
Signed-off-by: Freeman <freemanoparaocha@gmail.com>
@aornugent
Copy link
Contributor

@Namyalg - do you have time to read through this PR?

@Freeman-kuch - I've taken a quick look and it seems to be structured in a nicely modular way. You'll need to add more documentation to help us understand your design choices.

Thanks for the contribution!

This was referenced Dec 20, 2022
Closed
Closed
@aornugent aornugent mentioned this pull request Dec 20, 2022
Closed
Namyalg
Namyalg reviewed Dec 24, 2022
View reviewed changes
Copy link
Member

@Namyalg Namyalg left a comment •
edited

Choose a reason for hiding this comment

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

The design is modular and is in line with what we had discussed. I see @Freeman-kuch has extended Ankita's implementation.
With respect to the file preprocess.py , can we eliminate the assignment of hardcoded values? If we are to use this for a new set of inputs is there a way of generalising the values?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Namyalg Namyalg Namyalg left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

GCBM Refactor idea Draft
10 participants
@Freeman-kuch @aornugent @Namyalg @radistoubalidis @khanjasir90 @SanjaySinghRajpoot @Crystalsage @temitayopelumi @Saurabh-Suchak @clintonMF