Skip to content

Commit 1b6f42e

Browse files
Update README.md
1 parent a32e9ee commit 1b6f42e

4 files changed

Lines changed: 22 additions & 7 deletions

File tree

DataLibrary/MyCustomDataType.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
namespace DataLibrary
2525
{
2626
/// <summary>
27-
///
27+
/// Example custom data type
2828
/// </summary>
2929
public class MyCustomDataType : BaseData
3030
{

DataLibrary.sln renamed to MyCustomDataType.sln

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ VisualStudioVersion = 16.0.31205.134
55
MinimumVisualStudioVersion = 10.0.40219.1
66
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DataLibrary", "DataLibrary\DataLibrary.csproj", "{68E7301F-DEA2-4688-B519-DE5E59F6F252}"
77
EndProject
8-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Tests", "Tests\Tests.csproj", "{46223B6F-6400-4C76-9066-441E8ACB6A21}"
8+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tests", "Tests\Tests.csproj", "{46223B6F-6400-4C76-9066-441E8ACB6A21}"
99
EndProject
1010
Global
1111
GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -18,7 +18,6 @@ Global
1818
{68E7301F-DEA2-4688-B519-DE5E59F6F252}.Release|Any CPU.ActiveCfg = Release|Any CPU
1919
{68E7301F-DEA2-4688-B519-DE5E59F6F252}.Release|Any CPU.Build.0 = Release|Any CPU
2020
{46223B6F-6400-4C76-9066-441E8ACB6A21}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
21-
{46223B6F-6400-4C76-9066-441E8ACB6A21}.Debug|Any CPU.Build.0 = Debug|Any CPU
2221
{46223B6F-6400-4C76-9066-441E8ACB6A21}.Release|Any CPU.ActiveCfg = Release|Any CPU
2322
{46223B6F-6400-4C76-9066-441E8ACB6A21}.Release|Any CPU.Build.0 = Release|Any CPU
2423
EndGlobalSection

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,35 @@
1-
# LeanData
2-
3-
Lean custom data template repository
1+
# LeanDataSdk
42

53
### Getting started
64

75
#### Introduction
86

7+
The Lean Data SDK is a cross-platform template repository for developing custom data types for Lean. These data types will be consumed by trading algorithms and research environment.
8+
9+
It is composed by a .Net solution for the data type and example converter scripts.
10+
11+
#### Prerequisites
12+
13+
The solution targets dotnet 5, for installation instructions please follow (dotnet)[https://dotnet.microsoft.com/download].
14+
15+
The data downloader and converter script can be developed in different ways: Python script, C# or Python jupyter notebook or even a bash script.
916

17+
#### Installation
18+
19+
This repository should be forked by each new data provider.
20+
21+
Once it is cloned locally, should be able to successfully build the solution or execute the conveter scripts.
1022

1123
### User guide
1224

1325
### Tutorial
1426

1527
#### Create Data Type
1628

29+
##### Introduction
30+
31+
Creating a custom data type will allow Lean algorithms or research environment to consume a particular data set.
32+
1733
#### Create Algorithm
1834

1935
#### Create Data Converters

Tests/CustomDataAlgorithm.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public class CustomDataAlgorithm : QCAlgorithm
3131
/// </summary>
3232
public override void Initialize()
3333
{
34-
AddData<MyCustomDataType>("SPY");
34+
var security = AddData<MyCustomDataType>("SPY");
3535
}
3636

3737
/// <summary>

0 commit comments

Comments
 (0)