Billingegroup / rg-db-public

Public Research Group Database
BSD 2-Clause "Simplified" License
1 stars 71 forks source link

adding epfl to institutuions #542

Closed till-schertenleib closed 11 months ago

till-schertenleib commented 1 year ago

looks like the merging is blocked. I guess because this is the public branch? let me know if I shouldn't touch the public branch.

till-schertenleib commented 1 year ago

Ok I tried with the gui. Let me know if it didn't work.

till-schertenleib commented 1 year ago

It looks like I need to specify an index in the helper GUI. 'index of the item in the enumerated list to update'. How do I find or define this index?

sbillinge commented 1 year ago

It looks like I need to specify an index in the helper GUI. 'index of the item in the enumerated list to update'. How do I find or define this index?

yes, it is not completely intuitive unfortunately. For a new entry you put 1 there

till-schertenleib commented 1 year ago

Ok then I think it should be updated now.

sbillinge commented 1 year ago

Ok then I think it should be updated now.

That's great. Did you commit and push?

till-schertenleib commented 1 year ago

I'm a bit confused. Is it correct that I should run the helper_gui always from here: ~/dbs/rg-db-group/local ? like described here:https://gitlab.thebillingegroup.com/resources/group-wiki/-/wikis/Regolith%20Helpers%20Infrastructure

If I run the GUI there, it creates a file 'new_institution.yml'. Should I add this to git and then push and commit it?

I'm confused because I thought the point of using git is to alsway checkout into a new branch to make changes and the push them. But with the GUI I'm not in a separate branch...

sbillinge commented 1 year ago

the logic is that the "default" database that the helper_gui (hg) uses is the top one in the regolithrc.json file in the place where it was run. So if you run it from rg-db-group it will update the collection in rg-db-group, if you run it from rg-db-public it will update the collection in that db and so on.

To avoid confusion, regardless of where I run it from I usually put the database name explicitly inthe db field. In this case it doesn't matter which place you run it from.

The database names to give in the database field of the gui are: billingegroup-group billingegroup-public

They can be found in the regolithrc.json file.

S

On Wed, Sep 13, 2023 at 6:15 PM Till Schertenleib @.***> wrote:

I'm a bit confused. Is it correct that I should run the helper_gui always from here: ~/dbs/rg-db-group/local ? like described here: https://gitlab.thebillingegroup.com/resources/group-wiki/-/wikis/Regolith%20Helpers%20Infrastructure

If I run the GUI there, it creates a file 'new_institution.yml'. Should I add this to git and then push and commit it?

I'm confused because I thought the point of using git is to alsway checkout into a new branch to make changes and the push them. But with the GUI I'm not in a separate branch...

— Reply to this email directly, view it on GitHub https://github.com/Billingegroup/rg-db-public/pull/542#issuecomment-1718385747, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABAOWUO7XFN7S6UYO5RZFW3X2IV7PANCNFSM6AAAAAA4XCLK7Y . You are receiving this because your review was requested.Message ID: @.***>

-- Simon Billinge Professor, Columbia University

till-schertenleib commented 1 year ago

Okay I see. I didn't see that I could specify the database in the GUI. I tried again.... I think I did it correctly now and it worked

My workflow:

  1. create a new branch git checkout -b add_epfl_to_institute
  2. run the GUI while being in the public database - buy running the GUI, all it does is that it modifies the file, e.g. institutions.yml' right?
  3. I push and commit
  4. I check-out to the main branch

Is that correct? I guess I could have done the same from the group directory, but I would have had to specify the correct path to the target db in the GUI

sbillinge commented 1 year ago

The basic logic is that there is something like a matrix where the rows are the collections and the databases are columns. Databases are things like rg-db-group, collections are things like people. The databases have different access permissions, but when you run regolith (a builder or below gui) it will build the collection by taking info from all the databases specified in regolithrc.json.

On Wed, Sep 13, 2023, 7:06 PM Till Schertenleib @.***> wrote:

Okay I see. I didn't see that I could specify the database in the GUI. I tried again.... I think I did it correctly now and it worked

My workflow:

  1. create a new branch git checkout -b add_epfl_to_institute
  2. run the GUI while being in the public database - buy running the GUI, all it does is that it modifies the file, e.g. institutions.yml' right?
  3. I push and commit
  4. I check-out to the main branch

Is that correct? I guess I could have done the same from the group directory, but I would have had to specify the correct path to the target db in the GUI

— Reply to this email directly, view it on GitHub https://github.com/Billingegroup/rg-db-public/pull/542#issuecomment-1718423920, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABAOWUPOWPRBI6ICDRFSBMLX2I4APANCNFSM6AAAAAA4XCLK7Y . You are receiving this because your review was requested.Message ID: @.***>

till-schertenleib commented 1 year ago

Okay I see. I think my last try yesterday with the GUI worked. but I'm not sure if the commit and pull request went through..

sbillinge commented 1 year ago

I can check. Which database did you push to?

On Thu, Sep 14, 2023 at 9:02 AM Till Schertenleib @.***> wrote:

Okay I see. I think my last try yesterday with the GUI worked. but I'm not sure if the commit and pull request went through..

— Reply to this email directly, view it on GitHub https://github.com/Billingegroup/rg-db-public/pull/542#issuecomment-1719410738, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABAOWUO4WIIVQBKRSM5UBPTX2L55ZANCNFSM6AAAAAA4XCLK7Y . You are receiving this because your review was requested.Message ID: @.***>

-- Simon Billinge Professor, Columbia University

till-schertenleib commented 1 year ago

To the public/db - if I did it correctly...

till-schertenleib commented 1 year ago

Just for me to make sure I know how it works, I re-did everything using the helper_gui. I also committed and pushed to the public db.

sbillinge commented 1 year ago

This PR is failing CI. To see why click on "Details" next to the CI and you should be able to see the error message. because it is a database it is picky about the exact format, which is easy to get wrong when we edit it the db. if it seems confusing, read about the yaml format to understand the relationship between syntax and the meaning, it is a gift that will keep on giving.

sbillinge commented 1 year ago

@till-schertenleib gentle ping on this. Let me know if you need help

sbillinge commented 11 months ago

gentle ping on this. Can we merge or close it?

till-schertenleib commented 11 months ago

Since I couldn't find the syntax error, I freshly added epfl to institute.yml using the helper GUI. I just committed the changes.

sbillinge commented 11 months ago

haha, that took care of it!