Skip to content

Commit 4a3ca6f

Browse files
setup gradle update
1 parent 30cf93f commit 4a3ca6f

17 files changed

+168
-270
lines changed

docs/StardustDocs/d.tree

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414
</toc-element>
1515
</toc-element>
1616

17-
<toc-element topic="setup.md" accepts-web-file-names="installation.html">
18-
<toc-element topic="gettingStartedKotlinNotebook.md"/>
19-
<toc-element topic="gettingStartedGradle.md"/>
20-
<toc-element topic="gettingStartedJupyterNotebook.md"/>
21-
<toc-element topic="gettingStartedDatalore.md"/>
22-
<toc-element topic="gettingStartedGradleAdvanced.md"/>
17+
<toc-element topic="Setup.md" accepts-web-file-names="installation.html">
18+
<toc-element topic="SetupKotlinNotebook.md"/>
19+
<toc-element topic="SetupGradle.md"/>
20+
<toc-element topic="SetupJupyter.md"/>
21+
<toc-element topic="SetupDatalore.md"/>
22+
<toc-element topic="SetupAndroid.md"/>
2323
<toc-element topic="Modules.md"/>
2424
</toc-element>
2525
<toc-element topic="concepts.md" accepts-web-file-names="overview.html">

docs/StardustDocs/topics/FAQ.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To stay updated on progress, subscribe to the
2727
Yes — Kotlin DataFrame can be used in Android projects.
2828

2929
There is no dedicated Android artifact yet, but you can include the standard **JVM artifact**
30-
by setting up a [custom Gradle configuration](gettingStartedGradleAdvanced.md).
30+
by setting up a [custom Gradle configuration](SetupAndroid.md).
3131

3232
## How to start with Kotlin DataFrame ?
3333

@@ -41,7 +41,7 @@ to explore various use cases and deepen your understanding of Kotlin DataFrame.
4141

4242
For the best experience, Kotlin DataFrame is most effective in an interactive environment.
4343

44-
- **[Kotlin Notebook](gettingStartedKotlinNotebook.md)** is ideal for exploring Kotlin DataFrame.
44+
- **[Kotlin Notebook](SetupKotlinNotebook.md)** is ideal for exploring Kotlin DataFrame.
4545
Everything works out of the box — interactivity, rich rendering of DataFrames and plots.
4646
You can instantly see the results of each operation, view the contents of your DataFrames after every transformation,
4747
inspect individual rows and columns, and explore data step-by-step in a live and interactive way.
@@ -109,7 +109,7 @@ in a **type-safe** and **name-safe** way.
109109

110110
They are generated automatically when working with Kotlin DataFrame in:
111111

112-
- [Kotlin Notebook](gettingStartedKotlinNotebook.md), where extension properties are generated
112+
- [Kotlin Notebook](SetupKotlinNotebook.md), where extension properties are generated
113113
after each cell execution.
114114
- A Kotlin project in [IntelliJ IDEA](https://www.jetbrains.com/idea/) with the
115115
[](Compiler-Plugin.md) enabled, where the properties are generated at compile time.

docs/StardustDocs/topics/Home.topic

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
<primary>
2121
<title>First steps</title>
22-
<a href="gettingStartedKotlinNotebook.md"/>
22+
<a href="SetupKotlinNotebook.md"/>
2323
<a href="concepts.md"/>
2424
<a href="operations.md"/>
2525
<a href="read.md">Reading from files: CSV, JSON, ApacheArrow</a>

docs/StardustDocs/topics/collectionsInterop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ val df2 = df.add("c") { a + b }
7878
<tip>
7979

8080
To enable extension properties generation, you should use the [DataFrame plugin](schemasGradle.md)
81-
for Gradle or the [Kotlin Jupyter kernel](gettingStartedJupyterNotebook.md)
81+
for Gradle or the [Kotlin Jupyter kernel](SetupJupyter.md)
8282

8383
</tip>
8484

docs/StardustDocs/topics/extensionPropertiesApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ with the name and type of properties inferred from the name and type of the corr
88
It also works for all types of hierarchical dataframes.
99

1010
> The behavior of data schema generation differs between the
11-
> [Compiler Plugin](Compiler-Plugin.md) and [Kotlin Notebook](gettingStartedKotlinNotebook.md).
11+
> [Compiler Plugin](Compiler-Plugin.md) and [Kotlin Notebook](SetupKotlinNotebook.md).
1212
>
1313
> * In **Kotlin Notebook**, a schema is generated **only after cell execution** for
1414
> `DataFrame` variables defined within that cell.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
[//]: # (title: Setup Kotlin DataFrame)
2+
3+
<web-summary>
4+
Install Kotlin DataFrame in your preferred environment — Kotlin Notebook, Android, Jupyter, or Datalore
5+
— and start working with data right away.
6+
</web-summary>
7+
8+
<card-summary>
9+
Install Kotlin DataFrame in your preferred environment — Kotlin Notebook, Gradle, Android, Jupyter, or Datalore
10+
— and start working with data right away.
11+
</card-summary>
12+
13+
<link-summary>
14+
Step-by-step setup guide for using Kotlin DataFrame in different environments like Kotlin Notebook, Android, and Jupyter.
15+
</link-summary>
16+
17+
Kotlin DataFrame is supported in multiple environments — choose the one that suits you best and follow the setup steps.
18+
19+
- [**Setup in Kotlin Notebook**](SetupKotlinNotebook.md) — one-line Kotlin DataFrame setup for powerful interactive
20+
[Kotlin notebooks in IntelliJ IDEA and Android Studio](https://kotlinlang.org/docs/kotlin-notebook-overview.html).
21+
No configuration required, full IDE support.
22+
Perfect for learning Kotlin DataFrame basics and experimenting, and a great professional tool
23+
for [data analysis](https://kotlinlang.org/docs/data-analysis-overview.html).
24+
25+
- [**Setup in Gradle**](SetupGradle.md) — add Kotlin DataFrame to your Gradle project for convenient data handling
26+
in your Kotlin applications.
27+
28+
- [**Setup on Android**](SetupAndroid.md) — use Kotlin DataFrame in your Android apps to simplify local data processing
29+
and transformation.
30+
31+
- [**Setup on Datalore**](SetupDatalore.md) — run Kotlin DataFrame in
32+
[JetBrains Datalore](https://www.jetbrains.com/datalore/) notebooks,
33+
great for sharing and remote collaboration.
34+
35+
- [**Setup in Jupyter**](SetupJupyter.md) — integrate Kotlin DataFrame
36+
into interactive notebooks using the Kotlin Jupyter kernel.

docs/StardustDocs/topics/gettingStarted/gettingStartedGradleAdvanced.md renamed to docs/StardustDocs/topics/gettingStarted/SetupAndroid.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[//]: # (title: Get started with Kotlin DataFrame on Gradle with custom configuration)
1+
[//]: # (title: Setup Kotlin DataFrame on Android)
22

33
## Gradle
44

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[//]: # (title: Get started with Kotlin DataFrame on Datalore)
1+
[//]: # (title: Setup Kotlin DataFrame on Datalore)
22

33
## Datalore
44

@@ -7,7 +7,7 @@ To start with the Kotlin DataFrame library in Datalore, create a Kotlin notebook
77
![Installation in Datalore](datalore-1.png)
88

99
As the notebook you've created is a Jupyter Notebook, you can follow the instructions
10-
in the [previous section](gettingStartedJupyterNotebook.md) to use the Kotlin DataFrame library.
10+
in the [previous section](SetupJupyter.md) to use the Kotlin DataFrame library.
1111
The simplest way of doing this is shown in the screenshot:
1212

1313
![Datalore notebook](datalore-2.png)
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Setup Kotlin DataFrame in Gradle
2+
3+
Kotlin DataFrame can be added as usual Gradle dependency to your Kotlin project (
4+
for now only Kotlin/JVM is supported).
5+
6+
## Create a Kotlin project
7+
8+
1. In IntelliJ IDEA, select **File** | **New** | **Project**.
9+
2. In the panel on the left, select **New Project**.
10+
3. Name the new project and change its location, if necessary.
11+
12+
> Select the **Create Git repository** checkbox to place the new project under version control. You can enable this
13+
> later at any time.
14+
>
15+
{type="tip"}
16+
17+
4. From the **Language** list, select **Kotlin**.
18+
5. Select the **Gradle** build system.
19+
6. From the **JDK list**, select the [JDK](https://www.oracle.com/java/technologies/downloads/) that you want to use in
20+
your project. The minimum supported version is JDK 8.
21+
* If the JDK is installed on your computer, but not defined in the IDE, select **Add JDK** and specify the path to the
22+
JDK home directory.
23+
* If you don't have the necessary JDK on your computer, select **Download JDK**.
24+
7. From the **Gradle DSL** list, select **Kotlin** or **Groovy**.
25+
8. Select the **Add sample code** checkbox to create a file with a sample `"Hello World!"` application.
26+
9. Click **Create**.
27+
28+
You have successfully created a project with Gradle.
29+
30+
## Add Kotlin DataFrame Gradle dependency
31+
32+
In your Gradle build file (`build.gradle` or `build.gradle.kts`), add the Kotlin DataFrame library as a dependency:
33+
34+
<tabs>
35+
<tab title="Kotlin DSL">
36+
37+
```kotlin
38+
dependencies {
39+
implementation("org.jetbrains.kotlinx:dataframe:%dataFrameVersion%")
40+
}
41+
```
42+
43+
</tab>
44+
45+
<tab title="Groovy DSL">
46+
47+
```groovy
48+
dependencies {
49+
implementation 'org.jetbrains.kotlinx:dataframe:%dataFrameVersion%'
50+
}
51+
```
52+
53+
</tab>
54+
55+
</tabs>
56+
57+
This will add [general Kotlin DataFrame dependency](Modules.md#dataframe-general), i.e.,
58+
[core API and implementation](Modules.md#dataframe-core)
59+
as well as all [IO modules](Modules.md#io-modules)
60+
(excluding [experimental ones](Modules.md#experimental-modules)).
61+
For flexible dependencies configuration see [Custom configuration](#custom-configuration).
62+
63+
### Add imports
64+
65+
In `src/main/kotlin/Main.kt`, add the following imports at the top of the file:
66+
67+
```kotlin
68+
import org.jetbrains.kotlinx.dataframe.DataFrame
69+
import org.jetbrains.kotlinx.dataframe.io.*
70+
import org.jetbrains.kotlinx.dataframe.api.*
71+
```
72+
73+
## Hello World
74+
75+
Let’s create your first [`DataFrame`](DataFrame.md) in the notebook — a simple "Hello, World!" style example:
76+
77+
```kotlin
78+
import org.jetbrains.kotlinx.dataframe.api.dataFrameOf
79+
80+
fun main() {
81+
val df = dataFrameOf(
82+
"name" to listOf("Alice", "Bob"),
83+
"age" to listOf(25, 30)
84+
)
85+
86+
println(df)
87+
}
88+
```
89+
90+
Congratulations! You have successfully used the Kotlin DataFrame library to import, manipulate and export data.
91+
92+
93+
## Custom configuration
94+
95+
## Next steps
96+
* Learn more about how to [import and export data](io.md)
97+
* Learn about our different [access APIs](apiLevels.md)
98+
* Explore the many different [operations that you can perform](operations.md)

docs/StardustDocs/topics/gettingStarted/gettingStartedJupyterNotebook.md renamed to docs/StardustDocs/topics/gettingStarted/SetupJupyter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[//]: # (title: Get started with Kotlin DataFrame on Jupyter Notebook)
1+
[//]: # (title: Setup Kotlin DataFrame in Jupyter)
22

33
## Jupyter Notebook
44

0 commit comments

Comments
 (0)