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 citation information. #150

Merged
merged 2 commits into from
Jul 7, 2021
Merged

Update citation information. #150

merged 2 commits into from
Jul 7, 2021

Conversation

bdice
Copy link
Member

@bdice bdice commented Jul 5, 2021

Description

Adds new citation information for the SciPy 2021 proceedings paper (no DOI is available yet). For now, I recommend citing the new SciPy paper only in cases where the content specifically references the new features that have been recently added:

If your paper makes use of the signac-flow features for aggregation, groups, and bundling or signac features for synced collections, consider citing:

I reorganized citation information to use BibTeX files that match the format of the "Scientific Papers" page.

I made the recommended citation statement shorter, since I have seen several users (including myself) adapt the statement in this way.

Lastly, I edited some bibtex-tidy pre-commit settings to wrap content at 90 characters. That's what fits on screen (on a desktop or laptop) without creating a scroll bar.

Compare the ReadTheDocs build to the current page: https://docs.signac.io/en/latest/acknowledge.html

Motivation and Context

Updating citation information to make it clearer how to cite the software.

Checklist:

@bdice bdice requested review from a team as code owners July 5, 2021 23:05
@bdice bdice requested review from csadorf and cbkerr and removed request for a team July 5, 2021 23:05
docs/source/acknowledge.rst Outdated Show resolved Hide resolved
}

.. literalinclude:: acknowledge.bib
:language: bibtex
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd recommend to leave the easy copy & paste option. For some reason I believe that it makes it more likely for people to cite. Citations are extremely valuable for some of us and we should reduce any perceived barrier if possible.

If you think it's getting too large, maybe just show it for CompMat and add JS buttons to copy the other ones into the clipboard.

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree that this needs to be easy. I am not sure what you mean about the changes. If you mean copy-paste BibTeX, this is nearly equivalent to the existing page when rendered — look at what it does when rendered and let me know if it addresses your question here?

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah sorry, I was reviewing on my phone and thought you had replaced it with a download link. All good.

Copy link
Member

@cbkerr cbkerr left a comment

Choose a reason for hiding this comment

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

I couldn't find a RTD-built preview at https://readthedocs.org/projects/signac/builds/14172973/ but the diffs look good to me.

@bdice bdice merged commit 5613fa1 into master Jul 7, 2021
@bdice bdice deleted the update-citations branch July 7, 2021 20:28
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.

None yet

3 participants