Git Product home page Git Product logo

nuclear-database-apis's Introduction

Nuclear Database APIs

Purpose

For sharing source code and modules for pulling down important nuclear data from websites.

Motivation

If we can increase the scale of data ETL for nuclear databases, insights developed from examining these constants can be further refined.

Getting Started

A Python virtual environment (virtualenv) is recommended for work with the API scripts.

  1. To start the virtual environment, ensure your system level python interpreter has virtualenv installed.
$ pip install virtualenv
  1. From the root directory of the Nuclear Database APIs, activate the virtual environment.
$ . ./env/bin/activate

If you are using Bash or Zsh, you should see a small change to your terminal's prompt (env).

Example: Using the XCOM API

  1. Download the repo through GitHub via SSH or ZIP.

  2. Find the right webdriver for the browser you are using.

If you use Chrome, download page for Chrome's webdriver: (https://sites.google.com/a/chromium.org/chromedriver/).

  1. Add the binary executable webdriver to the virtual environment's bin/ directory.
$ cp ./Downloads/webdriver... ./path/to/env/bin/
  1. Change into the XCOM directory.
$ cd ./src/XCOM
  1. Run the xcom_api.py file after changing the config.json file which determines which data you will retrieve.
$ python xcom_api.py

Other Information

These scripts primarily rely on a 'Web Driver' which operates on an instance of a web browser.

For using Chrome, a chrome web driver is needed under your virtual environment's bin/ directory.

TODOs

-[ ] Update README in further detail. -[x] Look into using BS4 python library for web scraping. -[ ] Bootstrap PSTAR, ESTAR, and ASTAR code with XCOM groundwork. -[ ] Introduce embedded methods under API classes with visualizations from matplotlib.

Contact

For questions, direct to [email protected]

nuclear-database-apis's People

Contributors

jacobmiske avatar

Watchers

James Cloos avatar  avatar

Forkers

ruaridhmacd

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.