MLMI2-CSSI / foundry

Simplifying the discovery and usage of machine-learning ready datasets in materials science and chemistry
MIT License
80 stars 16 forks source link

"Quick start" in README won't work w/o Globus Connect Personal #372

Closed marshallmcdonnell closed 9 months ago

marshallmcdonnell commented 1 year ago

NOTE: This is related to JOSS review https://github.com/openjournals/joss-reviews/issues/5467

Is your feature request related to a problem? Please describe. In the "Quick Start", the globus=True is set for the Foundry.load() method.

Yet, this requires a Globus Connect Personal (or maybe Globus Connect Server) endpoint to be setup already.

There is no documentation link to set that up in the README.

Per the comment from @blaiszik, can easily disable this using globus=False.

Probably want the "quickstart" to work without a Globus endpoint (and globus=False by default)

Describe the solution you'd like Just use the default so a User doesn't have to configure a Globus endpoint for an introduction the package.

Describe alternatives you've considered Keep globus=True but add a "note" that you can set globus=False if you would like to not use a Globus endpoint

Additional context N/A