[docs] add links to the various data files in tutorials

jump-dev · Sep 18, 2023 · 7e20e59 · 7e20e59
1 parent 68f1cd0
commit 7e20e59
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 13 deletions.
diff --git a/docs/src/tutorials/getting_started/getting_started_with_data_and_plotting.jl b/docs/src/tutorials/getting_started/getting_started_with_data_and_plotting.jl
@@ -34,7 +34,11 @@
 # Before we get started, we need this constant to point to where the data files
 # are.
 
-const DATA_DIR = joinpath(@__DIR__, "data")
+import JuMP
+const DATA_DIR = joinpath(
+    dirname(pathof(JuMP)),
+    joinpath("..", "docs", "src", "tutorials", "getting_started", "data"),
+);
 
 # ## Where to get help
 

diff --git a/docs/src/tutorials/linear/factory_schedule.jl b/docs/src/tutorials/linear/factory_schedule.jl
@@ -86,14 +86,14 @@ import Test  #src
 # production and cost levels for each month. For the documentation, the file is
 # located at:
 
-factories_filename = joinpath(@__DIR__, "factory_schedule_factories.txt")
+factories_filename = joinpath(@__DIR__, "factory_schedule_factories.txt");
 
-# and it has the following contents:
+# To run locally, download [`factory_schedule_factories.txt`](factory_schedule_factories.txt)
+# and update `factories_filename` appropriately.
 
-print(read(factories_filename, String))
+# The file has the following contents:
 
-# You can reproduce this tutorial locally by saving the contents to a new file
-# and updating `factories_filename` appropriately.
+print(read(factories_filename, String))
 
 # We use the `CSV` and `DataFrames` packages to read it into Julia:
 
@@ -106,11 +106,10 @@ factory_df = CSV.read(
 
 # The second file contains the demand data by month:
 
-demand_filename = joinpath(@__DIR__, "factory_schedule_demand.txt")
+demand_filename = joinpath(@__DIR__, "factory_schedule_demand.txt");
 
-print(read(demand_filename, String))
-
-#-
+# To run locally, download [`factory_schedule_demand.txt`](factory_schedule_demand.txt)
+# and update `demand_filename` appropriately.
 
 demand_df = CSV.read(
     demand_filename,

diff --git a/docs/src/tutorials/linear/multi.jl b/docs/src/tutorials/linear/multi.jl
@@ -58,9 +58,16 @@ const DBInterface = SQLite.DBInterface
 # ## Data
 
 # For the purpose of this tutorial, the JuMP repository contains an example
-# database called `multi.sqlite`:
+# database called `multi.sqlite`.
 
-db = SQLite.DB(joinpath(@__DIR__, "multi.sqlite"))
+filename = joinpath(@__DIR__, "multi.sqlite");
+
+# To run locally, download [`multi.sqlite`](multi.sqlite) and update `filename`
+# appropriately.
+
+# Load the database using `SQLite.DB`:
+
+db = SQLite.DB(filename)
 
 # A quick way to see the schema of the database is via `SQLite.tables`:
 

diff --git a/docs/src/tutorials/linear/multi_commodity_network.jl b/docs/src/tutorials/linear/multi_commodity_network.jl
@@ -56,7 +56,14 @@ import Test  #src
 # For the purpose of this tutorial, the JuMP repository contains an example
 # database called `commodity_nz.db`:
 
-db = SQLite.DB(joinpath(@__DIR__, "commodity_nz.db"))
+filename = joinpath(@__DIR__, "commodity_nz.db");
+
+# To run locally, download [`commodity_nz.db`](commodity_nz.db) and update
+# `filename` appropriately.
+
+# Load the database using `SQLite.DB`:
+
+db = SQLite.DB(filename)
 
 # A quick way to see the schema of the database is via `SQLite.tables`: