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

JOSS Review: Example usage #166

Closed
rcannood opened this issue Feb 26, 2020 · 6 comments · Fixed by #174
Closed

JOSS Review: Example usage #166

rcannood opened this issue Feb 26, 2020 · 6 comments · Fixed by #174

Comments

@rcannood
Copy link
Contributor

rcannood commented Feb 26, 2020 •
edited
Loading

Please provide example usage in the documentation (README.md) on how to use MaterialNet (openjournals/joss-reviews#2105). For example, could you write a small markdown on how to perform a relevant analysis in this software? What information do you wish to obtain from MaterialNet?
@waxlamp
Copy link
Collaborator

waxlamp commented Feb 26, 2020

I am consulting with my co-authors and will add this information as soon as we have it.

@Luthaf
Copy link

Luthaf commented Mar 2, 2020

The example usage should also contains a description on how one could go from a database of materials to a full visualization: how to create the network, how to save it (which format(s) are accepted by MaterialNet), and how to load it in MaterialNet.

@Luthaf Luthaf mentioned this issue Mar 2, 2020
Open
@waxlamp waxlamp mentioned this issue Mar 3, 2020
Merged
@waxlamp
Copy link
Collaborator

waxlamp commented Mar 3, 2020

Please see this branch for an updated README that addresses these issues, and let me know what you think!

@rcannood
Copy link
Contributor Author

rcannood commented Mar 4, 2020

Looks good to me!

@Luthaf ?

@Luthaf
Copy link

Luthaf commented Mar 4, 2020

Look good to me too 👍

@rcannood
Copy link
Contributor Author

rcannood commented Mar 4, 2020

Alright, good job!

@rcannood rcannood closed this as completed Mar 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add example usage vignettes TRI-AMDD/materialnet
3 participants
@rcannood @waxlamp @Luthaf