Skip to content

Restructering the repo - #343

Merged
comcon1 merged 55 commits into
mainfrom
restructure
Oct 4, 2025
Merged

Restructering the repo#343
comcon1 merged 55 commits into
mainfrom
restructure

Conversation

@PicoCentauri

@PicoCentauri PicoCentauri commented Sep 16, 2025

Copy link
Copy Markdown
Collaborator

Fixes #200

TODO

  • add standalone scripts
  • move unit and regression tests into tox workflow
  • Build documentation based on tox -e docs
  • Add github workflows for tests, lint etc.
  • Build per PR docs based on read the docs
  • Add codecov token
  • Add developer docs for tox workflows

@PicoCentauri
PicoCentauri marked this pull request as ready for review September 18, 2025 10:01
@comcon1

comcon1 commented Oct 3, 2025

Copy link
Copy Markdown
Member

Current solution.

  • ToyData is moved to src/DatabankLib/data
  • init.py complains if data folders are set up in the same place where the package folder is located
  • user is supposed to run nml_initialize_data [toy/stable/dev] and then if toy - it copies from package data, if stable - copies from stable tag of BilayerData repo (if no git - it downloads and unpack release's zip), if dev - git is required, just simple clone is runned.
  • import DatabankLib complains when there is no dir set up EXCEPT being invoked from nml_initialize_data
  • test runs from tox first copy ToyData to test and then run tests

I'm satisfied with it. But any comments are welcome @PicoCentauri @MagnusSletten @batukav.

@comcon1

comcon1 commented Oct 3, 2025

Copy link
Copy Markdown
Member

Ok. Now we passed the tests. I will also take care about documentation a bit before we are done.

@comcon1
comcon1 requested a review from MagnusSletten October 4, 2025 12:33
@comcon1

comcon1 commented Oct 4, 2025

Copy link
Copy Markdown
Member

I added what I wanted. During my committing, I was inspecting all the changes, so I have already done a kind of review job here on your parts of code. Let's inspect the code added by me then, and we can merge.

@MagnusSletten MagnusSletten left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good! We can make a quick change to the small comments that are the wrong language, maybe we fix the init for windows later.


print(f""""Data initialized into {data_path}. Please do

$ source databank_env.rc

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is OS dependent, but maybe we expand to windows in separate PR? Not sure how many besides me use windows on the team. It's not a big change anyways.

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.

Restructuring the repo

3 participants