mdrepo

package
v0.3.11 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 2, 2026 License: BSD-3-Clause Imports: 17 Imported by: 0

Documentation

Index

Constants

View Source
const (
	SubmissionStatusFilename   string = "mdrepo-submission.%s.json"
	SubmissionMetadataFilename string = "mdrepo-metadata.toml"
)

Variables

This section is empty.

Functions

func GetMDRepoSimulationRelPath

func GetMDRepoSimulationRelPath(irodsPath string) (string, error)

func GetMDRepoTicketString

func GetMDRepoTicketString(tickets []MDRepoTicket) (string, error)

func GetMDRepoTicketStringFromToken

func GetMDRepoTicketStringFromToken(serviceURL string, token string) (string, error)

func GetSubmitMetadataPath

func GetSubmitMetadataPath(dirPath string) string

func HasSubmitMetadataInDir

func HasSubmitMetadataInDir(dirPath string) bool

func IsStatusFile

func IsStatusFile(filename string) bool

func ValidateSubmissionSourcePath

func ValidateSubmissionSourcePath(sourcePath string) error

func VerifySubmitMetadataViaServer

func VerifySubmitMetadataViaServer(sourcePaths []string, serviceURL string, token string, noID bool) error

Types

type MDRepoSubmitMetadata

type MDRepoSubmitMetadata struct {
	MetadataFilePath string `toml:"-"`
	SubmissionPath   string `toml:"-"`

	LeadContributorOrcid string              `toml:"lead_contributor_orcid"`
	TrajectoryFileNames  []string            `toml:"trajectory_file_names"`
	StructureFileName    string              `toml:"structure_file_name"`
	TopologyFileName     string              `toml:"topology_file_name"`
	AdditionalFiles      []map[string]string `toml:"additional_files"`
}

func ParseSubmitMetadataDir

func ParseSubmitMetadataDir(dirPath string) (*MDRepoSubmitMetadata, error)

func ParseSubmitMetadataFile

func ParseSubmitMetadataFile(filePath string) (*MDRepoSubmitMetadata, error)

func ParseSubmitMetadataString

func ParseSubmitMetadataString(metadataString string) (*MDRepoSubmitMetadata, error)

func (*MDRepoSubmitMetadata) GetFiles

func (meta *MDRepoSubmitMetadata) GetFiles() []string

func (*MDRepoSubmitMetadata) GetOrcID

func (meta *MDRepoSubmitMetadata) GetOrcID() (string, error)

func (*MDRepoSubmitMetadata) ValidateFiles

func (meta *MDRepoSubmitMetadata) ValidateFiles() error

type MDRepoTicket

type MDRepoTicket struct {
	IRODSTicket   string
	IRODSDataPath string
}

func GetMDRepoTicketFromString

func GetMDRepoTicketFromString(ticketString string) (MDRepoTicket, error)

func GetMDRepoTicketsFromString

func GetMDRepoTicketsFromString(ticketString string) ([]MDRepoTicket, error)

func (*MDRepoTicket) GetAccount

func (ticket *MDRepoTicket) GetAccount() (*irodsclient_types.IRODSAccount, error)

type MDRepoTicketObject

type MDRepoTicketObject struct {
	TicketString string `json:"tickets"`
}

type MDRepoVerifySubmitMetadataRequest

type MDRepoVerifySubmitMetadataRequest struct {
	LocalDataDirPath string `json:"directory"`
	MetadataTOML     string `json:"toml"`
	Token            string `json:"token"`
	NoID             bool   `json:"no_id"`
}

type MDRepoVerifySubmitMetadataResponse

type MDRepoVerifySubmitMetadataResponse struct {
	LocalDataDirPath string   `json:"directory"`
	Valid            bool     `json:"valid"`
	Errors           []string `json:"errors"`
}

type SubmitStatus

type SubmitStatus string
const (
	SubmitStatusUnknown    SubmitStatus = "unknown"
	SubmitStatusInProgress SubmitStatus = "inprogress"
	SubmitStatusErrored    SubmitStatus = "errored"
	SubmitStatusCompleted  SubmitStatus = "completed"
)

func (SubmitStatus) MarshalJSON

func (s SubmitStatus) MarshalJSON() ([]byte, error)

func (SubmitStatus) String

func (s SubmitStatus) String() string

func (*SubmitStatus) UnmarshalJSON

func (s *SubmitStatus) UnmarshalJSON(b []byte) error

type SubmitStatusEntry

type SubmitStatusEntry struct {
	IRODSPath string `json:"irods_path"`
	Size      int64  `json:"size"`
	MD5Hash   string `json:"md5_hash"`
}

type SubmitStatusFile

type SubmitStatusFile struct {
	TotalFileNumber int64               `json:"total_filenum"`
	TotalFileSize   int64               `json:"total_filesize"`
	Status          SubmitStatus        `json:"status"`
	Token           string              `json:"token"`
	Files           []SubmitStatusEntry `json:"files"`
	Time            time.Time           `json:"time"`
}

type SubmitStatusFileWriter

type SubmitStatusFileWriter struct {
	FileSystem      *fs.FileSystem
	DataRootPath    string
	Token           string
	TotalFileNumber int64
	TotalFileSize   int64
	Status          SubmitStatus
	Files           []SubmitStatusEntry
	Time            time.Time
}

func NewSubmitStatusFileWriter

func NewSubmitStatusFileWriter(filesystem *fs.FileSystem, token string, dataRootPath string) *SubmitStatusFileWriter

func (*SubmitStatusFileWriter) AddFile

func (*SubmitStatusFileWriter) CreateStatusFile

func (s *SubmitStatusFileWriter) CreateStatusFile() error

func (*SubmitStatusFileWriter) GetStatusFilename

func (s *SubmitStatusFileWriter) GetStatusFilename() string

func (*SubmitStatusFileWriter) SetCompleted

func (s *SubmitStatusFileWriter) SetCompleted()

func (*SubmitStatusFileWriter) SetErrored

func (s *SubmitStatusFileWriter) SetErrored()

func (*SubmitStatusFileWriter) SetInProgress

func (s *SubmitStatusFileWriter) SetInProgress()

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址