Skip to content

Add CITATION.cff file for academic referencing #985

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
Merged
jpn-- merged 5 commits into from
Sep 26, 2025
Merged

Add CITATION.cff file for academic referencing #985

jpn-- merged 5 commits into from
Sep 26, 2025

Conversation

Copy link
Contributor

Copilot AI commented Sep 26, 2025 •
edited
Loading

  • Explored repository structure and identified project metadata
  • Found project is ActivitySim with BSD 3-Clause license owned by Association of Metropolitan Planning Organizations Research Foundation
  • Confirmed no existing citation files (.cff or .bib)
  • Located project details in pyproject.toml and README.md
  • Create CITATION.cff file with appropriate metadata
  • Include project title, description, authors (Zephyr Foundation as specified), license, and repository information
  • Validate CITATION.cff file format and YAML structure
  • Test citation file functionality and BibTeX generation capability
  • Address review feedback: Remove city/country from authors and simplify preferred-citation title

The CITATION.cff file enables:

  1. GitHub's built-in citation widget with "Cite this repository" button
  2. Automatic generation of various citation formats including BibTeX
  3. Academic referencing for research that uses ActivitySim
  4. Proper attribution to the Zephyr Foundation as specified

Changes made per review:

  • Removed city and country fields from author entry to keep it clean
  • Simplified preferred-citation title to just "ActivitySim" instead of extended description
Original prompt

This section details on the original issue you should resolve

<issue_title>Adding a CITATION.cff file to your repo for academic referencing</issue_title>
<issue_description>Is there a way to create an academic citation of this repo. Bonus points if it's bibtex downloadable file. </issue_description>

<agent_instructions>The author of this software is "Zephyr Foundation".</agent_instructions>

Comments on the Issue (you are @copilot in this section)

Fixes #982

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI changed the title [WIP] Adding a CITATION.cff file to your repo for academic referencing Add CITATION.cff file for academic referencing Sep 26, 2025
Copilot AI requested a review from jpn-- September 26, 2025 12:29
jpn--
jpn-- requested changes Sep 26, 2025
View reviewed changes
Copy link
Member

@jpn-- jpn-- left a comment

Choose a reason for hiding this comment

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

Make changes as indicated.

CITATION.cff Outdated
abstract: "Advanced, open-source, activity-based travel behavior modeling software based on best software development practices for distribution at no charge to the public."
authors:
- name: "Zephyr Foundation"
city: "Various"
Copy link
Member

@jpn-- jpn-- Sep 26, 2025

Choose a reason for hiding this comment

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

remove city and country from authors.

Copy link
Contributor Author

Copilot AI Sep 26, 2025

Choose a reason for hiding this comment

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

Removed city and country fields from authors entry. Commit f480925

CITATION.cff Outdated
- "travel demand modeling"
preferred-citation:
type: software
title: "ActivitySim: Activity-Based Travel Modeling"
Copy link
Member

@jpn-- jpn-- Sep 26, 2025

Choose a reason for hiding this comment

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

title is just "ActivitySim"

Copy link
Contributor Author

Copilot AI Sep 26, 2025

Choose a reason for hiding this comment

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

Updated preferred-citation title to just "ActivitySim". Commit f480925

@jpn--
Change copyright holder in LICENSE file
44c056e 
Updated copyright holder from Association of Metropolitan Planning Organizations Research Foundation to Zephyr Foundation.
@jpn--
Update README to remove status badges
bcf91b4 
Removed Build and Coverage Status badges from README, and add link to Zephyr page.
@jpn-- jpn-- marked this pull request as ready for review September 26, 2025 18:03
@jpn--
Copy link
Member

jpn-- commented Sep 26, 2025

@copilot Please make the changes I requested.

Copy link
Contributor Author

Copilot AI commented Sep 26, 2025

@copilot Please make the changes I requested.

Made the requested changes to CITATION.cff file. Commit f480925

Copilot AI requested a review from jpn-- September 26, 2025 18:08
@jpn-- jpn-- merged commit 5e528fc into main Sep 26, 2025
3 checks passed
@jpn-- jpn-- deleted the copilot/fix-ad9e3256-da00-45fc-83b0-ff6e3c67025f branch September 26, 2025 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jpn-- jpn-- Awaiting requested review from jpn--

Assignees

@jpn-- jpn--

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Adding a CITATION.cff file to your repo for academic referencing

2 participants

@jpn--