Skip to content

Create a basic set of tools to retrieve paper information

License

Notifications You must be signed in to change notification settings

cities-lab/rr-measure-basic

 
 

Repository files navigation

Reproducibility in Transportation - Measurement tools development

Create a basic set of tools to retrieve paper information and measure its reproducibility.

How to use this repo

Create the virtual environment

To create the virtual environment from the environment.yml file, run the following commands:

conda env create -f environment.yml
conda activate RR-measure

About the Elsevier API usage

Get your API key

Elsevier API

Safely use your API key

Put the API key in a file named config.yaml in the parent directory ../config.yaml of this GitHub repo. The content of the file should be like this:

elsevier_api:
    api_key: your_api_key_here

Background information for the project

IEEE Xplore API to explore the journal

Elsevier API to explore the journal

Timeline

  • 2024-10-01: Project started
  • 2024-11-01: Dataset v0.1 created
  • 2024-11-15: Dataset v1.0 created (10k+ papers from 2019-2024 created)

Data sharing

The data-sharing license is still pending, but our goal is to release the data alongside the associated preprint for this project.

Automatic tools for Transportation Research

Create a database for paper metadata

API for searching paper information

Create a tool to retrieve paper information

API for retrieving paper information

Literature

Acknowledgement

It's a project developed under the instruction of materials from Wu et al. (2024). Views here are my own and do not represent the views of any organization.

Reference

  • C. Wu, B. Ghosh, Z. Zheng, and I. Martínez, “Reproducibility in transportation research: a hands-on tutorial.” IEEE International Conference on Intelligent Transportation Systems (ITSC), 2024. Online. Available: https://www.rerite.org/itsc24-rr-tutorial/

Tips for Git

git pull --rebase origin main
git add .
git commit -m "message"
git push origin main

Team

About

Create a basic set of tools to retrieve paper information

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Jupyter Notebook 79.1%
  • Python 8.3%
  • HTML 4.5%
  • R 4.2%
  • TeX 3.3%
  • Shell 0.6%