Skip to content
This repository has been archived by the owner on Mar 31, 2023. It is now read-only.

Commit

Permalink
🐛 fixed more broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
will-thompson-k committed Jan 15, 2023
1 parent 7b3e9e8 commit e078b17
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ See the [illustrated example](#illustrated-example) for a deep dive into what th

![zoooooom](/assets/plotter_video.gif)

! [tts](/assets/tts.png)

![orders](/assets/erratic_valuation_3.png)

## Contents
Expand All @@ -24,7 +26,7 @@ See the [illustrated example](#illustrated-example) for a deep dive into what th
- [💸Free Advice](#free-advice)
- [✏️Data Schema](#%EF%B8%8Fdata-schema)
- [🤔What is "Market Microstructure"?](#what-is-market-microstructure)
- [🛞Installation]#installation)
- [🛞Installation](#installation)
- [ 📜Reqs](#reqs)
- [𓊍To Do](#𓊍to-do)
- [Citation](#citation)
Expand All @@ -43,16 +45,16 @@ You should **B.Y.O.A** (_Bring Your Own Alpha_).
Here are some useful features to take note of 🥁:

1. ✨Plot **multiple** 🤹, asynchronous (unsampled) microstructure elements together on **the sample plot**: <ins>order book quotes</ins>, <ins>trades</ins>, <ins>orders</ins>, <ins>order acks</ins>, <ins>fills</ins> etc etc
2. ✨Analyze events on seconds, milliseconds, microseconds, _nanoseconds_ 🕳️ ➡️ zoom 🔎 in on the **most granular time unit** available to microstructure behavior.
3. ✨All axes are 🔗**linked** ➡️ <ins>zoom 🔎 in on one product, see what's happening in all others at that same timestamp</ins>
2. ✨Analyze events on seconds, milliseconds, microseconds, _nanoseconds_ 🕳️ : zoom 🔎 in on the **most granular time unit** available to microstructure behavior
3. ✨All axes are 🔗**linked** : 🔎 _zoom in on one product, see what's happening in all others at that same timestamp_

## 🧠Illustrated Example

To show why a tool like this might be useful, [here](/examples/README.md) is an example motivated from things seen in the wild.

<ins>Note</ins>: This data was painstakingly created _by hand_ 🤌 to appear quasi-realistic. I am not an artist 🧑‍🎨 nor is this real 🌎 data.

See the [legend](#plots-legend) 👇 to understand the plots further.
See the [legend](#%EF%B8%8Fplots-legend) 👇 to understand the plots further.

## 🧪Test It Out Right Now

Expand Down
8 changes: 4 additions & 4 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ Here is a gallery of hand-crafted examples to illustrate the value of such a too

<ins>Disclaimer</ins>: This data was painstakingly created _by hand_ 🤌 to appear quasi-realistic. I am not an artist 🧑‍🎨 nor is this real 🌎 data.

You may want to first check out [the legend](docs/legend/README.md) and perhaps [the 30 second primer on microstructure](/docs/micro_primer/README.md) prior.
You may want to first check out [the legend](/docs/legend/README.md) and perhaps [the 30 second primer on microstructure](/docs/micro_primer/README.md) prior.

## Example

This example contains 3 different "events" of interest commonly found in the wild:

1. <ins>Event 1:</ins> [💸 Erratic valuation](#event-1-erratic-valuation)
2. <ins>Event 2:</ins> [😔 Didn't send order](#event-2-didnt-send-order)
3. <ins>Event 3:</ins> [🚀 Trade-through-the-stack event](#event-3-trade-through-the-stack-event)
1. <ins>Event 1:</ins> [💸 Erratic valuation](#event-1--erratic-valuation)
2. <ins>Event 2:</ins> [😔 Didn't send order](#event-2--didnt-send-order)
3. <ins>Event 3:</ins> [🚀 Trade-through-the-stack event](#event-3--trade-through-the-stack-event)

![examples](/assets/zoomed_out_events.png)

Expand Down

0 comments on commit e078b17

Please sign in to comment.