No project description provided
Project description
lfsData
This document provides instructions on how to work with Git Large File Storage (LFS) for the `qomnet` project.Getting Started with Git LFS
Git LFS is a Git extension that improves handling of large files by replacing them with text pointers inside Git, while storing the file content on a remote server.
Downloading single file
Before execution of this script, create an access token with read_api
capability and set it as an Environment Variable
for GITLAB_ACCESS_TOKEN
. Here's how, depending on your operating system: (Gitlab token creation
tutorial)
- On Windows:
$env:GITLAB_ACCESS_TOKEN="your_access_token_here"
- On Linux:
export GITLAB_ACCESS_TOKEN="your_access_token_here"
It's also possible to set this variable in PyCharm. Check out this tutorial for guidance.
Once you've set the GITLAB_ACCESS_TOKEN
, you can download a file using the following Python function, which includes
these parameters:
host
: The domain from which we want to download the datasetid
: The ID of the desired repository, which can be found on the first page of each repositorybranch_name
: The name of the branch where the desired file or data is storedfile_path
: The address of the desired file in the repository
DataLoader().gitlab_download("https://git.arusha.dev", 123, "branch_name", "data/test.gz")
Executing this command initiates the file download process, which is accompanied by a progress bar. The downloaded file is placed in the HOME directory, at: .local/datasets/{project_id}/{branch_name}/{file_path}. You can locate your home directory path based on your operating system:
Operating system | Path |
---|---|
Windows | C:\Users<username> |
Linux | /home/ |
macOS | /Users/ |
In addition, you might find this tutorial about LFS very helpful.
Installation
To install Git LFS, use the following command:
git lfs install
Clone Repository
To clone repository with only pointer files, use following commands:
- Linux (bash):
GIT_LFS_SKIP_SMUDGE=1 git clone ssh://git@git.arusha.dev:9022/majd/datasets/qomnet.git
- Windows:
$env:GIT_LFS_SKIP_SMUDGE="1"
git clone ssh://git@git.arusha.dev:9022/majd/datasets/qomnet.git
Tracking Files :
git lfs track "*.psd"
git add .gitattributes
Committing & Pushing Changes :
To commit and push changes, type:
git add file.psd
git commit -m "Add design file"
git push origin main
For more information about Git LFS, check here
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.