Code Monkey home page Code Monkey logo

neutrino's Introduction

Build Status

neutrino

This project is under construction. Initial documentation can be found here.

Overview

The neutrino is a prototype framework that creates custom cryptocurrency portfolio health reports and executes data-driven orders via the Coinbase Pro platform. It is currently under development.

An immediate goal of this program is to provide actionable views that are not readily available on most of the major exchanges, such as:

  1. What is my total cost basis for N currency in terms of USD, considering all historical trades on my account including crypto-to-crypto transactions? What is my overall gain/loss given current market prices?
  2. What is the gain/loss of N currency's value from X reference point in time? Popular views show the 24-hour delta, but this moving window can lead to misleading reports. For example, a currency can see an increasingly positive 24-hour delta while simultaneously decreasing in price, provided there was a more servere downtrend 24 hours ago and a subsequent recovery in between.
  3. How are N..(N+n) currencies performing relative to each other, from X reference point in time?

For example, here's a simple prototype chart that shows the performance of various currencies relative to BTC with respect to a given point in time. This type of view provides clear apples-to-apples comparisons re: currency performance, and eliminates the moving window problem by using a fixed reference point in time. This particular chart is useful for traders who prefer BTC over fiat:

docs/_images/proto-view.jpg

Development Approach

Formation of the neutrino is taking place across three phrases. It is currently in Phase 1, as is evident by its lack of unit tests and meaningful documentation:

Phase 1 - Initial development
  • Framework and tooling
  • Data pulling features
  • Prototype CLI
  • Unit tests and documentation
Phase 2 - Reporting and analytics
  • Local database configuration
  • Analytics tooling
  • Reporting views and features
  • User manual
Phase 3 - Data-driven actions
  • Data posting features
  • Trading algorithms and implementation

Screenshots of the prototype CLI can be found in the initial documentation here.

neutrino's People

Contributors

joshuavictorchen avatar

Stargazers

 avatar

Watchers

 avatar

neutrino's Issues

Build and deploy documentation using `gh-pages`

Documentation for this project is currently built from the docs folder in the master branch, which clutters the change log with .html file updates for new commits.

Eliminate this behavior by updating this repo to use a gh-pages branch for documentation building/deployment.

Resources:

  1. https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site
  2. https://github.com/JamesIves/github-pages-deploy-action

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.