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

Update parameter management notebook #1541

Closed
rtimms opened this issue Jul 9, 2021 · 4 comments
Closed

Update parameter management notebook #1541

rtimms opened this issue Jul 9, 2021 · 4 comments

Comments

@rtimms
Copy link
Contributor

rtimms commented Jul 9, 2021

Update the parameter management notebook to show how to create a chemistry dict from your own parameters, e.g.
like this

Chen2020 = {
    "chemistry": "lithium_ion",
    "cell": "LGM50_Chen2020",
    "negative electrode": "graphite_Chen2020",
    "separator": "separator_Chen2020",
    "positive electrode": "nmc_Chen2020",
    "electrolyte": "lipf6_Nyman2008",
    "experiment": "1C_discharge_from_full_Chen2020",
    "sei": "example",
    "citation": "Chen2020",
}

but passing your own folder names.

This will make it easier for people who want to add an entirely new set locally, but using the cell, negative electrode, .... file structure.

@leomg08
Copy link

leomg08 commented Jul 13, 2021

I just wanted to point out that in my Spyder this had worked using ' ' instead of " " for some reason. Using " " returned an error...

@leomg08
Copy link

leomg08 commented Jul 13, 2021

I also wanted to ask a follow up question on this:
-> Within the custom parameter set folders, it is recommended to have a readme. file. I am not familiar with these so I have just used the readme. files from Chen2020 in my custom parameter folders but could not edit these, is this a problem or is this fine? My custom parameter set seems to be correctly read by Python when I print(parameter_values).

@rtimms
Copy link
Contributor Author

rtimms commented Jul 29, 2021

The readme just gives some information on where the parameters came from (e.g. gives references and any other notes)

@rtimms
Copy link
Contributor Author

rtimms commented Nov 1, 2022

Closing this as parameters are now provided more easily in a single file (see #2342). Third party sets can be added using entry points .

@rtimms rtimms closed this as completed Nov 1, 2022
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

No branches or pull requests

2 participants