Systematic Trading

The systematic-trading package is designed to provide tools and resources for systematic trading strategies. It includes datasets and strategy ideas to assist in developing and backtesting trading algorithms. For detailed instructions on how to use this package effectively, please refer to the associated Substack publication by visiting: https://edarchimbaud.substack.com/.

Installation

To install the systematic-trading package, follow these steps:

# Install python and its dependencies
sudo apt install python3 python3-pip python3-venv
# Clone the repository or download the package from the official source
git clone https://github.com/edarchimbaud/systematic-trading.git
# Navigate to the package directory
cd systematic-trading/
# Create a virtual environment
python3 -m venv ~/myenv
# Activate it
source ~/myenv/bin/activate
# Install the required dependencies by running
pip install -r requirements.txt

Usage

The systematic-trading package offers a range of functionalities for systematic trading analysis. Here are some examples of how to utilize the package:

Crawling Datasets:

PYTHONPATH=$PYTHONPATH:. python systematic_trading/datasets \
  --username [YOUR_HUGGINGFACE_USERNAME]

Crawling Strategy Ideas:

# Download SSRN paper abtract to a Kili project of id YOUR_KILI_PROJECT_ID
PYTHONPATH=$PYTHONPATH:. python systematic_trading/strategy_ideas \
  --mode abstract \
  --jel-code G14 \
  --from-page 1 \
  --kili-project-id [YOUR_KILI_PROJECT_ID]

# Use the abtracts labeled in YOUR_SOURCE_KILI_PROJECT_ID to download SSRN paper PDF
# into another Kili project YOUR_TARGET_KILI_PROJECT_ID
PYTHONPATH=$PYTHONPATH:. python systematic_trading/strategy_ideas \
  --mode paper \
  --src-kili-project-id [YOUR_SOURCE_KILI_PROJECT_ID] \
  --tgt-kili-project-id [YOUR_TARGET_KILI_PROJECT_ID]

# Transform the annotations of YOUR_KILI_PROJECT_ID into markdown strategy ID cards
PYTHONPATH=$PYTHONPATH:. python systematic_trading/strategy_ideas \
  --mode summary \
  --kili-project-id [YOUR_KILI_PROJECT_ID] \
  --tgt-folder [YOUR_TARGET_FOLDER]

Contributing

Contributions to the systematic-trading package are welcome! If you have any improvements, new datasets, or strategy ideas to share, please follow these guidelines:

Fork the repository and create a new branch for your feature.
Make your changes and ensure they adhere to the package's coding style.
Write tests to validate the functionality or provide sample usage examples.
Submit a pull request, clearly explaining the purpose and benefits of your contribution.

Please note that all contributions are subject to review and approval by the maintainers.

License

The systematic-trading package is released under the MIT license. See the LICENSE file for more details.

Contact

For any questions, issues, or suggestions regarding the systematic-trading package, please contact the maintainers or create an issue on the repository. We appreciate your feedback and involvement in improving the package.

Happy trading!

sharavsambuu / systematic-trading_by_edarchimbaud